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; 68ba1e511SMatthew Knepley PetscFList SNESList = PETSC_NULL; 78ba1e511SMatthew Knepley 88ba1e511SMatthew Knepley /* Logging support */ 922c6f798SBarry Smith PetscClassId SNES_CLASSID, DMSNES_CLASSID; 10f1c6b773SPeter Brune PetscLogEvent SNES_Solve, SNES_FunctionEval, SNES_JacobianEval, SNES_GSEval; 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 /*@ 76*bf388a1fSBarry 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 88*bf388a1fSBarry 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: 109*bf388a1fSBarry 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 115*bf388a1fSBarry 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); 1712d53ad75SBarry Smith if (classid != SNES_FILE_CLASSID) SETERRQ(((PetscObject)snes)->comm,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) { 2287adad957SLisandro Dalcin ierr = PetscViewerASCIIGetStdout(((PetscObject)snes)->comm,&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); 245a83599f4SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," tolerances: relative=%G, absolute=%G, solution=%G\n", 246c60f73f4SPeter Brune snes->rtol,snes->abstol,snes->stol);CHKERRQ(ierr); 24777431f27SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," total number of linear solver iterations=%D\n",snes->linear_its);CHKERRQ(ierr); 24877431f27SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," total number of function evaluations=%D\n",snes->nfuncs);CHKERRQ(ierr); 24917fe4bdfSPeter Brune if (snes->gridsequence) { 25017fe4bdfSPeter Brune ierr = PetscViewerASCIIPrintf(viewer," total number of grid sequence refinements=%D\n",snes->gridsequence);CHKERRQ(ierr); 25117fe4bdfSPeter Brune } 2529b94acceSBarry Smith if (snes->ksp_ewconv) { 253fa9f3622SBarry Smith kctx = (SNESKSPEW *)snes->kspconvctx; 2549b94acceSBarry Smith if (kctx) { 25577431f27SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," Eisenstat-Walker computation of KSP relative tolerance (version %D)\n",kctx->version);CHKERRQ(ierr); 256a83599f4SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," rtol_0=%G, rtol_max=%G, threshold=%G\n",kctx->rtol_0,kctx->rtol_max,kctx->threshold);CHKERRQ(ierr); 257a83599f4SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," gamma=%G, alpha=%G, alpha2=%G\n",kctx->gamma,kctx->alpha,kctx->alpha2);CHKERRQ(ierr); 2589b94acceSBarry Smith } 2599b94acceSBarry Smith } 260eb1f6c34SBarry Smith if (snes->lagpreconditioner == -1) { 261eb1f6c34SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," Preconditioned is never rebuilt\n");CHKERRQ(ierr); 262eb1f6c34SBarry Smith } else if (snes->lagpreconditioner > 1) { 263eb1f6c34SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," Preconditioned is rebuilt every %D new Jacobians\n",snes->lagpreconditioner);CHKERRQ(ierr); 264eb1f6c34SBarry Smith } 265eb1f6c34SBarry Smith if (snes->lagjacobian == -1) { 266eb1f6c34SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," Jacobian is never rebuilt\n");CHKERRQ(ierr); 267eb1f6c34SBarry Smith } else if (snes->lagjacobian > 1) { 26842f4f86dSBarry Smith ierr = PetscViewerASCIIPrintf(viewer," Jacobian is rebuilt every %D SNES iterations\n",snes->lagjacobian);CHKERRQ(ierr); 269eb1f6c34SBarry Smith } 2700f5bd95cSBarry Smith } else if (isstring) { 271317d6ea6SBarry Smith const char *type; 272454a90a3SBarry Smith ierr = SNESGetType(snes,&type);CHKERRQ(ierr); 273b0a32e0cSBarry Smith ierr = PetscViewerStringSPrintf(viewer," %-3.3s",type);CHKERRQ(ierr); 27455849f57SBarry Smith } else if (isbinary) { 27555849f57SBarry Smith PetscInt classid = SNES_FILE_CLASSID; 27655849f57SBarry Smith MPI_Comm comm; 27755849f57SBarry Smith PetscMPIInt rank; 27855849f57SBarry Smith char type[256]; 27955849f57SBarry Smith 28055849f57SBarry Smith ierr = PetscObjectGetComm((PetscObject)snes,&comm);CHKERRQ(ierr); 28155849f57SBarry Smith ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr); 28255849f57SBarry Smith if (!rank) { 28355849f57SBarry Smith ierr = PetscViewerBinaryWrite(viewer,&classid,1,PETSC_INT,PETSC_FALSE);CHKERRQ(ierr); 28455849f57SBarry Smith ierr = PetscStrncpy(type,((PetscObject)snes)->type_name,256);CHKERRQ(ierr); 28555849f57SBarry Smith ierr = PetscViewerBinaryWrite(viewer,type,256,PETSC_CHAR,PETSC_FALSE);CHKERRQ(ierr); 28655849f57SBarry Smith } 28755849f57SBarry Smith if (snes->ops->view) { 28855849f57SBarry Smith ierr = (*snes->ops->view)(snes,viewer);CHKERRQ(ierr); 28955849f57SBarry Smith } 29072a02f06SBarry Smith } else if (isdraw) { 29172a02f06SBarry Smith PetscDraw draw; 29272a02f06SBarry Smith char str[36]; 29389fd9fafSBarry Smith PetscReal x,y,bottom,h; 29472a02f06SBarry Smith 29572a02f06SBarry Smith ierr = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr); 29672a02f06SBarry Smith ierr = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr); 29772a02f06SBarry Smith ierr = PetscStrcpy(str,"SNES: ");CHKERRQ(ierr); 29872a02f06SBarry Smith ierr = PetscStrcat(str,((PetscObject)snes)->type_name);CHKERRQ(ierr); 29989fd9fafSBarry Smith ierr = PetscDrawBoxedString(draw,x,y,PETSC_DRAW_BLUE,PETSC_DRAW_BLACK,str,PETSC_NULL,&h);CHKERRQ(ierr); 30089fd9fafSBarry Smith bottom = y - h; 30172a02f06SBarry Smith ierr = PetscDrawPushCurrentPoint(draw,x,bottom);CHKERRQ(ierr); 302c4646bacSPeter Brune if (snes->ops->view) { 303c4646bacSPeter Brune ierr = (*snes->ops->view)(snes,viewer);CHKERRQ(ierr); 304c4646bacSPeter Brune } 30572a02f06SBarry Smith } 30672a02f06SBarry Smith if (snes->linesearch) { 30772a02f06SBarry Smith ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 30872a02f06SBarry Smith ierr = SNESGetSNESLineSearch(snes, &linesearch);CHKERRQ(ierr); 30972a02f06SBarry Smith ierr = SNESLineSearchView(linesearch, viewer);CHKERRQ(ierr); 31072a02f06SBarry Smith ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 31119bcc07fSBarry Smith } 31242f4f86dSBarry Smith if (snes->pc && snes->usespc) { 3134a0c5b0cSMatthew G Knepley ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 3144a0c5b0cSMatthew G Knepley ierr = SNESView(snes->pc, viewer);CHKERRQ(ierr); 3154a0c5b0cSMatthew G Knepley ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 3164a0c5b0cSMatthew G Knepley } 3172d53ad75SBarry Smith ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 3182d53ad75SBarry Smith ierr = DMGetDMSNES(snes->dm,&dmsnes);CHKERRQ(ierr); 3192d53ad75SBarry Smith ierr = DMSNESView(dmsnes, viewer);CHKERRQ(ierr); 3202d53ad75SBarry Smith ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 3212c155ee1SBarry Smith if (snes->usesksp) { 3222c155ee1SBarry Smith ierr = SNESGetKSP(snes,&ksp);CHKERRQ(ierr); 323b0a32e0cSBarry Smith ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 32494b7f48cSBarry Smith ierr = KSPView(ksp,viewer);CHKERRQ(ierr); 325b0a32e0cSBarry Smith ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 3262c155ee1SBarry Smith } 32772a02f06SBarry Smith if (isdraw) { 32872a02f06SBarry Smith PetscDraw draw; 32972a02f06SBarry Smith ierr = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr); 33072a02f06SBarry Smith ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr); 3317f1410a3SPeter Brune } 3323a40ed3dSBarry Smith PetscFunctionReturn(0); 3339b94acceSBarry Smith } 3349b94acceSBarry Smith 33576b2cf59SMatthew Knepley /* 33676b2cf59SMatthew Knepley We retain a list of functions that also take SNES command 33776b2cf59SMatthew Knepley line options. These are called at the end SNESSetFromOptions() 33876b2cf59SMatthew Knepley */ 33976b2cf59SMatthew Knepley #define MAXSETFROMOPTIONS 5 340a7cc72afSBarry Smith static PetscInt numberofsetfromoptions; 3416849ba73SBarry Smith static PetscErrorCode (*othersetfromoptions[MAXSETFROMOPTIONS])(SNES); 34276b2cf59SMatthew Knepley 343e74ef692SMatthew Knepley #undef __FUNCT__ 344e74ef692SMatthew Knepley #define __FUNCT__ "SNESAddOptionsChecker" 345ac226902SBarry Smith /*@C 34676b2cf59SMatthew Knepley SNESAddOptionsChecker - Adds an additional function to check for SNES options. 34776b2cf59SMatthew Knepley 34876b2cf59SMatthew Knepley Not Collective 34976b2cf59SMatthew Knepley 35076b2cf59SMatthew Knepley Input Parameter: 35176b2cf59SMatthew Knepley . snescheck - function that checks for options 35276b2cf59SMatthew Knepley 35376b2cf59SMatthew Knepley Level: developer 35476b2cf59SMatthew Knepley 35576b2cf59SMatthew Knepley .seealso: SNESSetFromOptions() 35676b2cf59SMatthew Knepley @*/ 3577087cfbeSBarry Smith PetscErrorCode SNESAddOptionsChecker(PetscErrorCode (*snescheck)(SNES)) 35876b2cf59SMatthew Knepley { 35976b2cf59SMatthew Knepley PetscFunctionBegin; 36076b2cf59SMatthew Knepley if (numberofsetfromoptions >= MAXSETFROMOPTIONS) { 361e32f2f54SBarry Smith SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE, "Too many options checkers, only %D allowed", MAXSETFROMOPTIONS); 36276b2cf59SMatthew Knepley } 36376b2cf59SMatthew Knepley othersetfromoptions[numberofsetfromoptions++] = snescheck; 36476b2cf59SMatthew Knepley PetscFunctionReturn(0); 36576b2cf59SMatthew Knepley } 36676b2cf59SMatthew Knepley 3677087cfbeSBarry Smith extern PetscErrorCode SNESDefaultMatrixFreeCreate2(SNES,Vec,Mat*); 368aa3661deSLisandro Dalcin 369aa3661deSLisandro Dalcin #undef __FUNCT__ 370aa3661deSLisandro Dalcin #define __FUNCT__ "SNESSetUpMatrixFree_Private" 371ace3abfcSBarry Smith static PetscErrorCode SNESSetUpMatrixFree_Private(SNES snes, PetscBool hasOperator, PetscInt version) 372aa3661deSLisandro Dalcin { 373aa3661deSLisandro Dalcin Mat J; 374aa3661deSLisandro Dalcin KSP ksp; 375aa3661deSLisandro Dalcin PC pc; 376ace3abfcSBarry Smith PetscBool match; 377aa3661deSLisandro Dalcin PetscErrorCode ierr; 378aa3661deSLisandro Dalcin 379aa3661deSLisandro Dalcin PetscFunctionBegin; 3800700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 381aa3661deSLisandro Dalcin 38298613b67SLisandro Dalcin if (!snes->vec_func && (snes->jacobian || snes->jacobian_pre)) { 38398613b67SLisandro Dalcin Mat A = snes->jacobian, B = snes->jacobian_pre; 38498613b67SLisandro Dalcin ierr = MatGetVecs(A ? A : B, PETSC_NULL,&snes->vec_func);CHKERRQ(ierr); 38598613b67SLisandro Dalcin } 38698613b67SLisandro Dalcin 387aa3661deSLisandro Dalcin if (version == 1) { 388aa3661deSLisandro Dalcin ierr = MatCreateSNESMF(snes,&J);CHKERRQ(ierr); 38998613b67SLisandro Dalcin ierr = MatMFFDSetOptionsPrefix(J,((PetscObject)snes)->prefix);CHKERRQ(ierr); 3909c6ac3b3SBarry Smith ierr = MatSetFromOptions(J);CHKERRQ(ierr); 391aa3661deSLisandro Dalcin } else if (version == 2) { 392e32f2f54SBarry Smith if (!snes->vec_func) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"SNESSetFunction() must be called first"); 39382a7e548SBarry Smith #if !defined(PETSC_USE_COMPLEX) && !defined(PETSC_USE_REAL_SINGLE) && !defined(PETSC_USE_REAL___FLOAT128) 394aa3661deSLisandro Dalcin ierr = SNESDefaultMatrixFreeCreate2(snes,snes->vec_func,&J);CHKERRQ(ierr); 395aa3661deSLisandro Dalcin #else 396e32f2f54SBarry Smith SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP, "matrix-free operator rutines (version 2)"); 397aa3661deSLisandro Dalcin #endif 398a8248277SBarry Smith } else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE, "matrix-free operator rutines, only version 1 and 2"); 399aa3661deSLisandro Dalcin 400aa3661deSLisandro Dalcin ierr = PetscInfo1(snes,"Setting default matrix-free operator routines (version %D)\n", version);CHKERRQ(ierr); 401d3462f78SMatthew Knepley if (hasOperator) { 4023232da50SPeter Brune 403aa3661deSLisandro Dalcin /* This version replaces the user provided Jacobian matrix with a 404aa3661deSLisandro Dalcin matrix-free version but still employs the user-provided preconditioner matrix. */ 405aa3661deSLisandro Dalcin ierr = SNESSetJacobian(snes,J,0,0,0);CHKERRQ(ierr); 406aa3661deSLisandro Dalcin } else { 407aa3661deSLisandro Dalcin /* This version replaces both the user-provided Jacobian and the user- 4083232da50SPeter Brune provided preconditioner Jacobian with the default matrix free version. */ 409172a4300SPeter Brune if ((snes->pcside == PC_LEFT) && snes->pc) { 410172a4300SPeter Brune ierr = SNESSetJacobian(snes,J,0,0,0);CHKERRQ(ierr); 411172a4300SPeter Brune } else { 41228a52e04SBarry Smith ierr = SNESSetJacobian(snes,J,J,MatMFFDComputeJacobian,0);CHKERRQ(ierr); 413172a4300SPeter Brune } 414aa3661deSLisandro Dalcin /* Force no preconditioner */ 415aa3661deSLisandro Dalcin ierr = SNESGetKSP(snes,&ksp);CHKERRQ(ierr); 416aa3661deSLisandro Dalcin ierr = KSPGetPC(ksp,&pc);CHKERRQ(ierr); 417251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)pc,PCSHELL,&match);CHKERRQ(ierr); 418aa3661deSLisandro Dalcin if (!match) { 419aa3661deSLisandro Dalcin ierr = PetscInfo(snes,"Setting default matrix-free preconditioner routines\nThat is no preconditioner is being used\n");CHKERRQ(ierr); 420aa3661deSLisandro Dalcin ierr = PCSetType(pc,PCNONE);CHKERRQ(ierr); 421aa3661deSLisandro Dalcin } 422aa3661deSLisandro Dalcin } 4236bf464f9SBarry Smith ierr = MatDestroy(&J);CHKERRQ(ierr); 424aa3661deSLisandro Dalcin PetscFunctionReturn(0); 425aa3661deSLisandro Dalcin } 426aa3661deSLisandro Dalcin 4274a2ae208SSatish Balay #undef __FUNCT__ 428dfe15315SJed Brown #define __FUNCT__ "DMRestrictHook_SNESVecSol" 429dfe15315SJed Brown static PetscErrorCode DMRestrictHook_SNESVecSol(DM dmfine,Mat Restrict,Vec Rscale,Mat Inject,DM dmcoarse,void *ctx) 430dfe15315SJed Brown { 431dfe15315SJed Brown SNES snes = (SNES)ctx; 432dfe15315SJed Brown PetscErrorCode ierr; 433dfe15315SJed Brown Vec Xfine,Xfine_named = PETSC_NULL,Xcoarse; 434dfe15315SJed Brown 435dfe15315SJed Brown PetscFunctionBegin; 43616ebb321SJed Brown if (PetscLogPrintInfo) { 43716ebb321SJed Brown PetscInt finelevel,coarselevel,fineclevel,coarseclevel; 43816ebb321SJed Brown ierr = DMGetRefineLevel(dmfine,&finelevel);CHKERRQ(ierr); 43916ebb321SJed Brown ierr = DMGetCoarsenLevel(dmfine,&fineclevel);CHKERRQ(ierr); 44016ebb321SJed Brown ierr = DMGetRefineLevel(dmcoarse,&coarselevel);CHKERRQ(ierr); 44116ebb321SJed Brown ierr = DMGetCoarsenLevel(dmcoarse,&coarseclevel);CHKERRQ(ierr); 44216ebb321SJed Brown ierr = PetscInfo4(dmfine,"Restricting SNES solution vector from level %D-%D to level %D-%D\n",finelevel,fineclevel,coarselevel,coarseclevel);CHKERRQ(ierr); 44316ebb321SJed Brown } 444dfe15315SJed Brown if (dmfine == snes->dm) Xfine = snes->vec_sol; 445dfe15315SJed Brown else { 446dfe15315SJed Brown ierr = DMGetNamedGlobalVector(dmfine,"SNESVecSol",&Xfine_named);CHKERRQ(ierr); 447dfe15315SJed Brown Xfine = Xfine_named; 448dfe15315SJed Brown } 449dfe15315SJed Brown ierr = DMGetNamedGlobalVector(dmcoarse,"SNESVecSol",&Xcoarse);CHKERRQ(ierr); 450dfe15315SJed Brown ierr = MatRestrict(Restrict,Xfine,Xcoarse);CHKERRQ(ierr); 451dfe15315SJed Brown ierr = VecPointwiseMult(Xcoarse,Xcoarse,Rscale);CHKERRQ(ierr); 452dfe15315SJed Brown ierr = DMRestoreNamedGlobalVector(dmcoarse,"SNESVecSol",&Xcoarse);CHKERRQ(ierr); 453dfe15315SJed Brown if (Xfine_named) {ierr = DMRestoreNamedGlobalVector(dmfine,"SNESVecSol",&Xfine_named);CHKERRQ(ierr);} 454dfe15315SJed Brown PetscFunctionReturn(0); 455dfe15315SJed Brown } 456dfe15315SJed Brown 457dfe15315SJed Brown #undef __FUNCT__ 45816ebb321SJed Brown #define __FUNCT__ "DMCoarsenHook_SNESVecSol" 45916ebb321SJed Brown static PetscErrorCode DMCoarsenHook_SNESVecSol(DM dm,DM dmc,void *ctx) 46016ebb321SJed Brown { 46116ebb321SJed Brown PetscErrorCode ierr; 46216ebb321SJed Brown 46316ebb321SJed Brown PetscFunctionBegin; 46416ebb321SJed Brown ierr = DMCoarsenHookAdd(dmc,DMCoarsenHook_SNESVecSol,DMRestrictHook_SNESVecSol,ctx);CHKERRQ(ierr); 46516ebb321SJed Brown PetscFunctionReturn(0); 46616ebb321SJed Brown } 46716ebb321SJed Brown 46816ebb321SJed Brown #undef __FUNCT__ 469caa4e7f2SJed Brown #define __FUNCT__ "KSPComputeOperators_SNES" 470a6950cb2SJed Brown /* This may be called to rediscretize the operator on levels of linear multigrid. The DM shuffle is so the user can 471a6950cb2SJed Brown * safely call SNESGetDM() in their residual evaluation routine. */ 472caa4e7f2SJed Brown static PetscErrorCode KSPComputeOperators_SNES(KSP ksp,Mat A,Mat B,MatStructure *mstruct,void *ctx) 473caa4e7f2SJed Brown { 474caa4e7f2SJed Brown SNES snes = (SNES)ctx; 475caa4e7f2SJed Brown PetscErrorCode ierr; 476caa4e7f2SJed Brown Mat Asave = A,Bsave = B; 477dfe15315SJed Brown Vec X,Xnamed = PETSC_NULL; 478dfe15315SJed Brown DM dmsave; 4794e269d77SPeter Brune void *ctxsave; 4804e269d77SPeter Brune PetscErrorCode (*jac)(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 481caa4e7f2SJed Brown 482caa4e7f2SJed Brown PetscFunctionBegin; 483dfe15315SJed Brown dmsave = snes->dm; 484dfe15315SJed Brown ierr = KSPGetDM(ksp,&snes->dm);CHKERRQ(ierr); 485dfe15315SJed Brown if (dmsave == snes->dm) X = snes->vec_sol; /* We are on the finest level */ 486dfe15315SJed Brown else { /* We are on a coarser level, this vec was initialized using a DM restrict hook */ 487dfe15315SJed Brown ierr = DMGetNamedGlobalVector(snes->dm,"SNESVecSol",&Xnamed);CHKERRQ(ierr); 488dfe15315SJed Brown X = Xnamed; 4894e269d77SPeter Brune ierr = SNESGetJacobian(snes,PETSC_NULL,PETSC_NULL,&jac,&ctxsave);CHKERRQ(ierr); 4904e269d77SPeter Brune /* If the DM's don't match up, the MatFDColoring context needed for the jacobian won't match up either -- fixit. */ 4914e269d77SPeter Brune if (jac == SNESDefaultComputeJacobianColor) { 4924e269d77SPeter Brune ierr = SNESSetJacobian(snes,PETSC_NULL,PETSC_NULL,SNESDefaultComputeJacobianColor,0);CHKERRQ(ierr); 493dfe15315SJed Brown } 4944e269d77SPeter Brune } 4954e269d77SPeter Brune /* put the previous context back */ 4964e269d77SPeter Brune 497dfe15315SJed Brown ierr = SNESComputeJacobian(snes,X,&A,&B,mstruct);CHKERRQ(ierr); 4984e269d77SPeter Brune if (snes->dm != dmsave && jac == SNESDefaultComputeJacobianColor) { 4994e269d77SPeter Brune ierr = SNESSetJacobian(snes,PETSC_NULL,PETSC_NULL,jac,ctxsave);CHKERRQ(ierr); 5004e269d77SPeter Brune } 5014e269d77SPeter Brune 502caa4e7f2SJed Brown if (A != Asave || B != Bsave) SETERRQ(((PetscObject)snes)->comm,PETSC_ERR_SUP,"No support for changing matrices at this time"); 503dfe15315SJed Brown if (Xnamed) { 504dfe15315SJed Brown ierr = DMRestoreNamedGlobalVector(snes->dm,"SNESVecSol",&Xnamed);CHKERRQ(ierr); 505dfe15315SJed Brown } 506dfe15315SJed Brown snes->dm = dmsave; 507caa4e7f2SJed Brown PetscFunctionReturn(0); 508caa4e7f2SJed Brown } 509caa4e7f2SJed Brown 510caa4e7f2SJed Brown #undef __FUNCT__ 5116cab3a1bSJed Brown #define __FUNCT__ "SNESSetUpMatrices" 5126cab3a1bSJed Brown /*@ 5136cab3a1bSJed Brown SNESSetUpMatrices - ensures that matrices are available for SNES, to be called by SNESSetUp_XXX() 5146cab3a1bSJed Brown 5156cab3a1bSJed Brown Collective 5166cab3a1bSJed Brown 5176cab3a1bSJed Brown Input Arguments: 5186cab3a1bSJed Brown . snes - snes to configure 5196cab3a1bSJed Brown 5206cab3a1bSJed Brown Level: developer 5216cab3a1bSJed Brown 5226cab3a1bSJed Brown .seealso: SNESSetUp() 5236cab3a1bSJed Brown @*/ 5246cab3a1bSJed Brown PetscErrorCode SNESSetUpMatrices(SNES snes) 5256cab3a1bSJed Brown { 5266cab3a1bSJed Brown PetscErrorCode ierr; 5276cab3a1bSJed Brown DM dm; 528942e3340SBarry Smith DMSNES sdm; 5296cab3a1bSJed Brown 5306cab3a1bSJed Brown PetscFunctionBegin; 5316cab3a1bSJed Brown ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr); 532942e3340SBarry Smith ierr = DMGetDMSNES(dm,&sdm);CHKERRQ(ierr); 53322c6f798SBarry Smith if (!sdm->ops->computejacobian) { 534942e3340SBarry Smith SETERRQ(((PetscObject)snes)->comm,PETSC_ERR_PLIB,"DMSNES not properly configured"); 5353232da50SPeter Brune } else if (!snes->jacobian && snes->mf) { 5366cab3a1bSJed Brown Mat J; 5376cab3a1bSJed Brown void *functx; 5386cab3a1bSJed Brown ierr = MatCreateSNESMF(snes,&J);CHKERRQ(ierr); 5396cab3a1bSJed Brown ierr = MatMFFDSetOptionsPrefix(J,((PetscObject)snes)->prefix);CHKERRQ(ierr); 5406cab3a1bSJed Brown ierr = MatSetFromOptions(J);CHKERRQ(ierr); 5416cab3a1bSJed Brown ierr = SNESGetFunction(snes,PETSC_NULL,PETSC_NULL,&functx);CHKERRQ(ierr); 5423232da50SPeter Brune ierr = SNESSetJacobian(snes,J,J,0,0);CHKERRQ(ierr); 5436cab3a1bSJed Brown ierr = MatDestroy(&J);CHKERRQ(ierr); 544caa4e7f2SJed Brown } else if (snes->mf_operator && !snes->jacobian_pre && !snes->jacobian) { 5456cab3a1bSJed Brown Mat J,B; 5466cab3a1bSJed Brown ierr = MatCreateSNESMF(snes,&J);CHKERRQ(ierr); 5476cab3a1bSJed Brown ierr = MatMFFDSetOptionsPrefix(J,((PetscObject)snes)->prefix);CHKERRQ(ierr); 5486cab3a1bSJed Brown ierr = MatSetFromOptions(J);CHKERRQ(ierr); 5496cab3a1bSJed Brown ierr = DMCreateMatrix(snes->dm,MATAIJ,&B);CHKERRQ(ierr); 55006f20277SJed Brown /* sdm->computejacobian was already set to reach here */ 55106f20277SJed Brown ierr = SNESSetJacobian(snes,J,B,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr); 5526cab3a1bSJed Brown ierr = MatDestroy(&J);CHKERRQ(ierr); 5536cab3a1bSJed Brown ierr = MatDestroy(&B);CHKERRQ(ierr); 554caa4e7f2SJed Brown } else if (!snes->jacobian_pre) { 5556cab3a1bSJed Brown Mat J,B; 5566cab3a1bSJed Brown J = snes->jacobian; 5576cab3a1bSJed Brown ierr = DMCreateMatrix(snes->dm,MATAIJ,&B);CHKERRQ(ierr); 5586cab3a1bSJed Brown ierr = SNESSetJacobian(snes,J?J:B,B,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr); 5596cab3a1bSJed Brown ierr = MatDestroy(&B);CHKERRQ(ierr); 5606cab3a1bSJed Brown } 561caa4e7f2SJed Brown { 562caa4e7f2SJed Brown KSP ksp; 563caa4e7f2SJed Brown ierr = SNESGetKSP(snes,&ksp);CHKERRQ(ierr); 564caa4e7f2SJed Brown ierr = KSPSetComputeOperators(ksp,KSPComputeOperators_SNES,snes);CHKERRQ(ierr); 56516ebb321SJed Brown ierr = DMCoarsenHookAdd(snes->dm,DMCoarsenHook_SNESVecSol,DMRestrictHook_SNESVecSol,snes);CHKERRQ(ierr); 566caa4e7f2SJed Brown } 5676cab3a1bSJed Brown PetscFunctionReturn(0); 5686cab3a1bSJed Brown } 5696cab3a1bSJed Brown 5706cab3a1bSJed Brown #undef __FUNCT__ 5714a2ae208SSatish Balay #define __FUNCT__ "SNESSetFromOptions" 5729b94acceSBarry Smith /*@ 57394b7f48cSBarry Smith SNESSetFromOptions - Sets various SNES and KSP parameters from user options. 5749b94acceSBarry Smith 575c7afd0dbSLois Curfman McInnes Collective on SNES 576c7afd0dbSLois Curfman McInnes 5779b94acceSBarry Smith Input Parameter: 5789b94acceSBarry Smith . snes - the SNES context 5799b94acceSBarry Smith 58036851e7fSLois Curfman McInnes Options Database Keys: 581ea630c6eSPeter Brune + -snes_type <type> - ls, tr, ngmres, ncg, richardson, qn, vi, fas 58282738288SBarry Smith . -snes_stol - convergence tolerance in terms of the norm 58382738288SBarry Smith of the change in the solution between steps 58470441072SBarry Smith . -snes_atol <abstol> - absolute tolerance of residual norm 585b39c3a46SLois Curfman McInnes . -snes_rtol <rtol> - relative decrease in tolerance norm from initial 586b39c3a46SLois Curfman McInnes . -snes_max_it <max_it> - maximum number of iterations 587b39c3a46SLois Curfman McInnes . -snes_max_funcs <max_funcs> - maximum number of function evaluations 5884839bfe8SBarry Smith . -snes_max_fail <max_fail> - maximum number of line search failures allowed before stopping, default is none 589ddf469c8SBarry Smith . -snes_max_linear_solve_fail - number of linear solver failures before SNESSolve() stops 590a8054027SBarry Smith . -snes_lag_preconditioner <lag> - how often preconditioner is rebuilt (use -1 to never rebuild) 591e35cf81dSBarry Smith . -snes_lag_jacobian <lag> - how often Jacobian is rebuilt (use -1 to never rebuild) 592b39c3a46SLois Curfman McInnes . -snes_trtol <trtol> - trust region tolerance 5932492ecdbSBarry Smith . -snes_no_convergence_test - skip convergence test in nonlinear 59482738288SBarry Smith solver; hence iterations will continue until max_it 5951fbbfb26SLois Curfman McInnes or some other criterion is reached. Saves expense 59682738288SBarry Smith of convergence test 597e8105e01SRichard Katz . -snes_monitor <optional filename> - prints residual norm at each iteration. if no 598e8105e01SRichard Katz filename given prints to stdout 599a6570f20SBarry Smith . -snes_monitor_solution - plots solution at each iteration 600a6570f20SBarry Smith . -snes_monitor_residual - plots residual (not its norm) at each iteration 601a6570f20SBarry Smith . -snes_monitor_solution_update - plots update to solution at each iteration 6024619e776SBarry Smith . -snes_monitor_lg_residualnorm - plots residual norm at each iteration 603459f5d12SBarry Smith . -snes_monitor_lg_range - plots residual norm at each iteration 604e24b481bSBarry Smith . -snes_fd - use finite differences to compute Jacobian; very slow, only for testing 605e2e60de9SPeter Brune . -snes_fd_color - use finite differences with coloring to compute Jacobian 6065968eb51SBarry Smith . -snes_mf_ksp_monitor - if using matrix-free multiply then print h at each KSP iteration 607fee2055bSBarry Smith - -snes_converged_reason - print the reason for convergence/divergence after each solve 60882738288SBarry Smith 60982738288SBarry Smith Options Database for Eisenstat-Walker method: 610fa9f3622SBarry Smith + -snes_ksp_ew - use Eisenstat-Walker method for determining linear system convergence 6114b27c08aSLois Curfman McInnes . -snes_ksp_ew_version ver - version of Eisenstat-Walker method 61236851e7fSLois Curfman McInnes . -snes_ksp_ew_rtol0 <rtol0> - Sets rtol0 61336851e7fSLois Curfman McInnes . -snes_ksp_ew_rtolmax <rtolmax> - Sets rtolmax 61436851e7fSLois Curfman McInnes . -snes_ksp_ew_gamma <gamma> - Sets gamma 61536851e7fSLois Curfman McInnes . -snes_ksp_ew_alpha <alpha> - Sets alpha 61636851e7fSLois Curfman McInnes . -snes_ksp_ew_alpha2 <alpha2> - Sets alpha2 61736851e7fSLois Curfman McInnes - -snes_ksp_ew_threshold <threshold> - Sets threshold 61882738288SBarry Smith 61911ca99fdSLois Curfman McInnes Notes: 62011ca99fdSLois Curfman McInnes To see all options, run your program with the -help option or consult 6210598bfebSBarry Smith the <A href="../../docs/manual.pdf#nameddest=ch_snes">SNES chapter of the users manual</A>. 62283e2fdc7SBarry Smith 62336851e7fSLois Curfman McInnes Level: beginner 62436851e7fSLois Curfman McInnes 6259b94acceSBarry Smith .keywords: SNES, nonlinear, set, options, database 6269b94acceSBarry Smith 62769ed319cSSatish Balay .seealso: SNESSetOptionsPrefix() 6289b94acceSBarry Smith @*/ 6297087cfbeSBarry Smith PetscErrorCode SNESSetFromOptions(SNES snes) 6309b94acceSBarry Smith { 631d8f46077SPeter Brune PetscBool flg,pcset; 632d8f46077SPeter Brune PetscInt i,indx,lag,grids; 633aa3661deSLisandro Dalcin MatStructure matflag; 63404d7464bSBarry Smith const char *deft = SNESNEWTONLS; 63585385478SLisandro Dalcin const char *convtests[] = {"default","skip"}; 63685385478SLisandro Dalcin SNESKSPEW *kctx = NULL; 637e8105e01SRichard Katz char type[256], monfilename[PETSC_MAX_PATH_LEN]; 638649052a6SBarry Smith PetscViewer monviewer; 63985385478SLisandro Dalcin PetscErrorCode ierr; 640c40d0f55SPeter Brune PCSide pcside; 641a64e098fSPeter Brune const char *optionsprefix; 6429b94acceSBarry Smith 6433a40ed3dSBarry Smith PetscFunctionBegin; 6440700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 645ca161407SBarry Smith 646186905e3SBarry Smith if (!SNESRegisterAllCalled) {ierr = SNESRegisterAll(PETSC_NULL);CHKERRQ(ierr);} 6473194b578SJed Brown ierr = PetscObjectOptionsBegin((PetscObject)snes);CHKERRQ(ierr); 6487adad957SLisandro Dalcin if (((PetscObject)snes)->type_name) { deft = ((PetscObject)snes)->type_name; } 649b0a32e0cSBarry Smith ierr = PetscOptionsList("-snes_type","Nonlinear solver method","SNESSetType",SNESList,deft,type,256,&flg);CHKERRQ(ierr); 650d64ed03dSBarry Smith if (flg) { 651186905e3SBarry Smith ierr = SNESSetType(snes,type);CHKERRQ(ierr); 6527adad957SLisandro Dalcin } else if (!((PetscObject)snes)->type_name) { 653186905e3SBarry Smith ierr = SNESSetType(snes,deft);CHKERRQ(ierr); 654d64ed03dSBarry Smith } 65590d69ab7SBarry Smith /* not used here, but called so will go into help messaage */ 656909c8a9fSBarry Smith ierr = PetscOptionsName("-snes_view","Print detailed information on solver used","SNESView",0);CHKERRQ(ierr); 65793c39befSBarry Smith 658c60f73f4SPeter Brune ierr = PetscOptionsReal("-snes_stol","Stop if step length less than","SNESSetTolerances",snes->stol,&snes->stol,0);CHKERRQ(ierr); 65957034d6fSHong Zhang ierr = PetscOptionsReal("-snes_atol","Stop if function norm less than","SNESSetTolerances",snes->abstol,&snes->abstol,0);CHKERRQ(ierr); 660186905e3SBarry Smith 66157034d6fSHong Zhang ierr = PetscOptionsReal("-snes_rtol","Stop if decrease in function norm less than","SNESSetTolerances",snes->rtol,&snes->rtol,0);CHKERRQ(ierr); 662b0a32e0cSBarry Smith ierr = PetscOptionsInt("-snes_max_it","Maximum iterations","SNESSetTolerances",snes->max_its,&snes->max_its,PETSC_NULL);CHKERRQ(ierr); 663b0a32e0cSBarry Smith ierr = PetscOptionsInt("-snes_max_funcs","Maximum function evaluations","SNESSetTolerances",snes->max_funcs,&snes->max_funcs,PETSC_NULL);CHKERRQ(ierr); 66424254dc1SJed Brown ierr = PetscOptionsInt("-snes_max_fail","Maximum nonlinear step failures","SNESSetMaxNonlinearStepFailures",snes->maxFailures,&snes->maxFailures,PETSC_NULL);CHKERRQ(ierr); 665ddf469c8SBarry Smith ierr = PetscOptionsInt("-snes_max_linear_solve_fail","Maximum failures in linear solves allowed","SNESSetMaxLinearSolveFailures",snes->maxLinearSolveFailures,&snes->maxLinearSolveFailures,PETSC_NULL);CHKERRQ(ierr); 666acfcf0e5SJed Brown ierr = PetscOptionsBool("-snes_error_if_not_converged","Generate error if solver does not converge","SNESSetErrorIfNotConverged",snes->errorifnotconverged,&snes->errorifnotconverged,PETSC_NULL);CHKERRQ(ierr); 66785385478SLisandro Dalcin 668a8054027SBarry Smith ierr = PetscOptionsInt("-snes_lag_preconditioner","How often to rebuild preconditioner","SNESSetLagPreconditioner",snes->lagpreconditioner,&lag,&flg);CHKERRQ(ierr); 669a8054027SBarry Smith if (flg) { 670a8054027SBarry Smith ierr = SNESSetLagPreconditioner(snes,lag);CHKERRQ(ierr); 671a8054027SBarry Smith } 672e35cf81dSBarry Smith ierr = PetscOptionsInt("-snes_lag_jacobian","How often to rebuild Jacobian","SNESSetLagJacobian",snes->lagjacobian,&lag,&flg);CHKERRQ(ierr); 673e35cf81dSBarry Smith if (flg) { 674e35cf81dSBarry Smith ierr = SNESSetLagJacobian(snes,lag);CHKERRQ(ierr); 675e35cf81dSBarry Smith } 676efd51863SBarry Smith ierr = PetscOptionsInt("-snes_grid_sequence","Use grid sequencing to generate initial guess","SNESSetGridSequence",snes->gridsequence,&grids,&flg);CHKERRQ(ierr); 677efd51863SBarry Smith if (flg) { 678efd51863SBarry Smith ierr = SNESSetGridSequence(snes,grids);CHKERRQ(ierr); 679efd51863SBarry Smith } 680a8054027SBarry Smith 68185385478SLisandro Dalcin ierr = PetscOptionsEList("-snes_convergence_test","Convergence test","SNESSetConvergenceTest",convtests,2,"default",&indx,&flg);CHKERRQ(ierr); 68285385478SLisandro Dalcin if (flg) { 68385385478SLisandro Dalcin switch (indx) { 6847f7931b9SBarry Smith case 0: ierr = SNESSetConvergenceTest(snes,SNESDefaultConverged,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr); break; 6857f7931b9SBarry Smith case 1: ierr = SNESSetConvergenceTest(snes,SNESSkipConverged,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr); break; 68685385478SLisandro Dalcin } 68785385478SLisandro Dalcin } 68885385478SLisandro Dalcin 689acfcf0e5SJed Brown ierr = PetscOptionsBool("-snes_converged_reason","Print reason for converged or diverged","SNESSolve",snes->printreason,&snes->printreason,PETSC_NULL);CHKERRQ(ierr); 690186905e3SBarry Smith 691fdacfa88SPeter Brune ierr = PetscOptionsEList("-snes_norm_type","SNES Norm type","SNESSetNormType",SNESNormTypes,5,"function",&indx,&flg);CHKERRQ(ierr); 692fdacfa88SPeter Brune if (flg) { ierr = SNESSetNormType(snes,(SNESNormType)indx);CHKERRQ(ierr); } 693fdacfa88SPeter Brune 69485385478SLisandro Dalcin kctx = (SNESKSPEW *)snes->kspconvctx; 69585385478SLisandro Dalcin 696acfcf0e5SJed Brown ierr = PetscOptionsBool("-snes_ksp_ew","Use Eisentat-Walker linear system convergence test","SNESKSPSetUseEW",snes->ksp_ewconv,&snes->ksp_ewconv,PETSC_NULL);CHKERRQ(ierr); 697186905e3SBarry Smith 698fa9f3622SBarry Smith ierr = PetscOptionsInt("-snes_ksp_ew_version","Version 1, 2 or 3","SNESKSPSetParametersEW",kctx->version,&kctx->version,0);CHKERRQ(ierr); 699fa9f3622SBarry Smith ierr = PetscOptionsReal("-snes_ksp_ew_rtol0","0 <= rtol0 < 1","SNESKSPSetParametersEW",kctx->rtol_0,&kctx->rtol_0,0);CHKERRQ(ierr); 700fa9f3622SBarry Smith ierr = PetscOptionsReal("-snes_ksp_ew_rtolmax","0 <= rtolmax < 1","SNESKSPSetParametersEW",kctx->rtol_max,&kctx->rtol_max,0);CHKERRQ(ierr); 701fa9f3622SBarry Smith ierr = PetscOptionsReal("-snes_ksp_ew_gamma","0 <= gamma <= 1","SNESKSPSetParametersEW",kctx->gamma,&kctx->gamma,0);CHKERRQ(ierr); 702fa9f3622SBarry Smith ierr = PetscOptionsReal("-snes_ksp_ew_alpha","1 < alpha <= 2","SNESKSPSetParametersEW",kctx->alpha,&kctx->alpha,0);CHKERRQ(ierr); 703fa9f3622SBarry Smith ierr = PetscOptionsReal("-snes_ksp_ew_alpha2","alpha2","SNESKSPSetParametersEW",kctx->alpha2,&kctx->alpha2,0);CHKERRQ(ierr); 704fa9f3622SBarry Smith ierr = PetscOptionsReal("-snes_ksp_ew_threshold","0 < threshold < 1","SNESKSPSetParametersEW",kctx->threshold,&kctx->threshold,0);CHKERRQ(ierr); 705186905e3SBarry Smith 70690d69ab7SBarry Smith flg = PETSC_FALSE; 7075341784dSBarry Smith ierr = PetscOptionsBool("-snes_check_jacobian","Check each Jacobian with a differenced one","SNESUpdateCheckJacobian",flg,&flg,PETSC_NULL);CHKERRQ(ierr); 7085341784dSBarry Smith if (flg) { 7095341784dSBarry Smith ierr = SNESSetUpdate(snes,SNESUpdateCheckJacobian);CHKERRQ(ierr); 7105341784dSBarry Smith } 7115341784dSBarry Smith 7125341784dSBarry Smith flg = PETSC_FALSE; 713acfcf0e5SJed Brown ierr = PetscOptionsBool("-snes_monitor_cancel","Remove all monitors","SNESMonitorCancel",flg,&flg,PETSC_NULL);CHKERRQ(ierr); 714a6570f20SBarry Smith if (flg) {ierr = SNESMonitorCancel(snes);CHKERRQ(ierr);} 715eabae89aSBarry Smith 716a6570f20SBarry Smith ierr = PetscOptionsString("-snes_monitor","Monitor norm of function","SNESMonitorSet","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 717e8105e01SRichard Katz if (flg) { 718649052a6SBarry Smith ierr = PetscViewerASCIIOpen(((PetscObject)snes)->comm,monfilename,&monviewer);CHKERRQ(ierr); 719649052a6SBarry Smith ierr = SNESMonitorSet(snes,SNESMonitorDefault,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr); 720e8105e01SRichard Katz } 721eabae89aSBarry Smith 722b271bb04SBarry Smith ierr = PetscOptionsString("-snes_monitor_range","Monitor range of elements of function","SNESMonitorSet","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 723b271bb04SBarry Smith if (flg) { 724b271bb04SBarry Smith ierr = SNESMonitorSet(snes,SNESMonitorRange,0,0);CHKERRQ(ierr); 725b271bb04SBarry Smith } 726b271bb04SBarry Smith 727a6570f20SBarry Smith ierr = PetscOptionsString("-snes_ratiomonitor","Monitor ratios of norms of function","SNESMonitorSetRatio","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 728eabae89aSBarry Smith if (flg) { 729649052a6SBarry Smith ierr = PetscViewerASCIIOpen(((PetscObject)snes)->comm,monfilename,&monviewer);CHKERRQ(ierr); 730f1bef1bcSMatthew Knepley ierr = SNESMonitorSetRatio(snes,monviewer);CHKERRQ(ierr); 731e8105e01SRichard Katz } 732eabae89aSBarry Smith 733a6570f20SBarry Smith ierr = PetscOptionsString("-snes_monitor_short","Monitor norm of function (fewer digits)","SNESMonitorSet","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 734eabae89aSBarry Smith if (flg) { 735649052a6SBarry Smith ierr = PetscViewerASCIIOpen(((PetscObject)snes)->comm,monfilename,&monviewer);CHKERRQ(ierr); 736649052a6SBarry Smith ierr = SNESMonitorSet(snes,SNESMonitorDefaultShort,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr); 737eabae89aSBarry Smith } 738eabae89aSBarry Smith 7395180491cSLisandro Dalcin ierr = PetscOptionsString("-snes_monitor_python","Use Python function","SNESMonitorSet",0,monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 7405180491cSLisandro Dalcin if (flg) {ierr = PetscPythonMonitorSet((PetscObject)snes,monfilename);CHKERRQ(ierr);} 7415180491cSLisandro Dalcin 74290d69ab7SBarry Smith flg = PETSC_FALSE; 743acfcf0e5SJed Brown ierr = PetscOptionsBool("-snes_monitor_solution","Plot solution at each iteration","SNESMonitorSolution",flg,&flg,PETSC_NULL);CHKERRQ(ierr); 744a6570f20SBarry Smith if (flg) {ierr = SNESMonitorSet(snes,SNESMonitorSolution,0,0);CHKERRQ(ierr);} 74590d69ab7SBarry Smith flg = PETSC_FALSE; 746acfcf0e5SJed Brown ierr = PetscOptionsBool("-snes_monitor_solution_update","Plot correction at each iteration","SNESMonitorSolutionUpdate",flg,&flg,PETSC_NULL);CHKERRQ(ierr); 747a6570f20SBarry Smith if (flg) {ierr = SNESMonitorSet(snes,SNESMonitorSolutionUpdate,0,0);CHKERRQ(ierr);} 74890d69ab7SBarry Smith flg = PETSC_FALSE; 749acfcf0e5SJed Brown ierr = PetscOptionsBool("-snes_monitor_residual","Plot residual at each iteration","SNESMonitorResidual",flg,&flg,PETSC_NULL);CHKERRQ(ierr); 750a6570f20SBarry Smith if (flg) {ierr = SNESMonitorSet(snes,SNESMonitorResidual,0,0);CHKERRQ(ierr);} 75190d69ab7SBarry Smith flg = PETSC_FALSE; 7524619e776SBarry Smith ierr = PetscOptionsBool("-snes_monitor_lg_residualnorm","Plot function norm at each iteration","SNESMonitorLGResidualNorm",flg,&flg,PETSC_NULL);CHKERRQ(ierr); 753459f5d12SBarry Smith if (flg) { 754459f5d12SBarry Smith PetscDrawLG ctx; 755459f5d12SBarry Smith 756459f5d12SBarry Smith ierr = SNESMonitorLGCreate(0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,&ctx);CHKERRQ(ierr); 757459f5d12SBarry Smith ierr = SNESMonitorSet(snes,SNESMonitorLGResidualNorm,ctx,(PetscErrorCode (*)(void**))SNESMonitorLGDestroy);CHKERRQ(ierr); 758459f5d12SBarry Smith } 75990d69ab7SBarry Smith flg = PETSC_FALSE; 7604619e776SBarry Smith ierr = PetscOptionsBool("-snes_monitor_lg_range","Plot function range at each iteration","SNESMonitorLGRange",flg,&flg,PETSC_NULL);CHKERRQ(ierr); 761459f5d12SBarry Smith if (flg) { 762459f5d12SBarry Smith PetscViewer ctx; 763e24b481bSBarry Smith 764459f5d12SBarry Smith ierr = PetscViewerDrawOpen(((PetscObject)snes)->comm,0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,&ctx);CHKERRQ(ierr); 765459f5d12SBarry Smith ierr = SNESMonitorSet(snes,SNESMonitorLGRange,ctx,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr); 766459f5d12SBarry Smith } 7672e7541e6SPeter Brune 7682e7541e6SPeter Brune flg = PETSC_FALSE; 7692e7541e6SPeter Brune ierr = PetscOptionsBool("-snes_monitor_jacupdate_spectrum","Print the change in the spectrum of the Jacobian","SNESMonitorJacUpdateSpectrum",flg,&flg,PETSC_NULL);CHKERRQ(ierr); 7702e7541e6SPeter Brune if (flg) {ierr = SNESMonitorSet(snes,SNESMonitorJacUpdateSpectrum,0,0);CHKERRQ(ierr);} 7712e7541e6SPeter Brune 77290d69ab7SBarry Smith flg = PETSC_FALSE; 773acfcf0e5SJed Brown ierr = PetscOptionsBool("-snes_fd","Use finite differences (slow) to compute Jacobian","SNESDefaultComputeJacobian",flg,&flg,PETSC_NULL);CHKERRQ(ierr); 7744b27c08aSLois Curfman McInnes if (flg) { 7756cab3a1bSJed Brown void *functx; 7766cab3a1bSJed Brown ierr = SNESGetFunction(snes,PETSC_NULL,PETSC_NULL,&functx);CHKERRQ(ierr); 7776cab3a1bSJed Brown ierr = SNESSetJacobian(snes,snes->jacobian,snes->jacobian_pre,SNESDefaultComputeJacobian,functx);CHKERRQ(ierr); 778ae15b995SBarry Smith ierr = PetscInfo(snes,"Setting default finite difference Jacobian matrix\n");CHKERRQ(ierr); 7799b94acceSBarry Smith } 780639f9d9dSBarry Smith 78144848bc4SPeter Brune flg = PETSC_FALSE; 78297584545SPeter Brune ierr = PetscOptionsBool("-snes_fd_function","Use finite differences (slow) to compute function from user objective","SNESDefaultObjectiveComputeFunctionFD",flg,&flg,PETSC_NULL);CHKERRQ(ierr); 78397584545SPeter Brune if (flg) { 78497584545SPeter Brune ierr = SNESSetFunction(snes,PETSC_NULL,SNESDefaultObjectiveComputeFunctionFD,PETSC_NULL);CHKERRQ(ierr); 78597584545SPeter Brune } 78697584545SPeter Brune 78797584545SPeter Brune flg = PETSC_FALSE; 78844848bc4SPeter Brune ierr = PetscOptionsBool("-snes_fd_color","Use finite differences with coloring to compute Jacobian","SNESDefaultComputeJacobianColor",flg,&flg,PETSC_NULL);CHKERRQ(ierr); 78944848bc4SPeter Brune if (flg) { 79044848bc4SPeter Brune void *functx; 79144848bc4SPeter Brune ierr = SNESGetFunction(snes,PETSC_NULL,PETSC_NULL,&functx);CHKERRQ(ierr); 7920171d955SPeter Brune ierr = SNESSetJacobian(snes,snes->jacobian,snes->jacobian_pre,SNESDefaultComputeJacobianColor,0);CHKERRQ(ierr); 79344848bc4SPeter Brune ierr = PetscInfo(snes,"Setting default finite difference coloring Jacobian matrix\n");CHKERRQ(ierr); 79444848bc4SPeter Brune } 79544848bc4SPeter Brune 796aa3661deSLisandro Dalcin flg = PETSC_FALSE; 797d8f46077SPeter 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); 798d8f46077SPeter Brune if (flg && snes->mf_operator) { 799a8248277SBarry Smith snes->mf_operator = PETSC_TRUE; 800d8f46077SPeter Brune snes->mf = PETSC_TRUE; 801a8248277SBarry Smith } 802aa3661deSLisandro Dalcin flg = PETSC_FALSE; 803d8f46077SPeter Brune ierr = PetscOptionsBool("-snes_mf","Use a Matrix-Free Jacobian with no preconditioner matrix","MatCreateSNESMF",PETSC_FALSE,&snes->mf,&flg);CHKERRQ(ierr); 804d8f46077SPeter Brune if (!flg && snes->mf_operator) snes->mf = PETSC_TRUE; 805d8f46077SPeter Brune ierr = PetscOptionsInt("-snes_mf_version","Matrix-Free routines version 1 or 2","None",snes->mf_version,&snes->mf_version,0);CHKERRQ(ierr); 806d28543b3SPeter Brune 807c40d0f55SPeter Brune flg = PETSC_FALSE; 80822d28d08SBarry Smith ierr = SNESGetPCSide(snes,&pcside);CHKERRQ(ierr); 809c40d0f55SPeter Brune ierr = PetscOptionsEnum("-snes_npc_side","SNES nonlinear preconditioner side","SNESSetPCSide",PCSides,(PetscEnum)pcside,(PetscEnum*)&pcside,&flg);CHKERRQ(ierr); 810c40d0f55SPeter Brune if (flg) {ierr = SNESSetPCSide(snes,pcside);CHKERRQ(ierr);} 811c40d0f55SPeter Brune 81289b92e6fSPeter Brune /* GS Options */ 81389b92e6fSPeter Brune ierr = PetscOptionsInt("-snes_gs_sweeps","Number of sweeps of GS to apply","SNESComputeGS",snes->gssweeps,&snes->gssweeps,PETSC_NULL);CHKERRQ(ierr); 81489b92e6fSPeter Brune 81576b2cf59SMatthew Knepley for (i = 0; i < numberofsetfromoptions; i++) { 81676b2cf59SMatthew Knepley ierr = (*othersetfromoptions[i])(snes);CHKERRQ(ierr); 81776b2cf59SMatthew Knepley } 81876b2cf59SMatthew Knepley 819e7788613SBarry Smith if (snes->ops->setfromoptions) { 820e7788613SBarry Smith ierr = (*snes->ops->setfromoptions)(snes);CHKERRQ(ierr); 821639f9d9dSBarry Smith } 8225d973c19SBarry Smith 8235d973c19SBarry Smith /* process any options handlers added with PetscObjectAddOptionsHandler() */ 8245d973c19SBarry Smith ierr = PetscObjectProcessOptionsHandlers((PetscObject)snes);CHKERRQ(ierr); 825b0a32e0cSBarry Smith ierr = PetscOptionsEnd();CHKERRQ(ierr); 8264bbc92c1SBarry Smith 8271cee3971SBarry Smith if (!snes->ksp) {ierr = SNESGetKSP(snes,&snes->ksp);CHKERRQ(ierr);} 82822d28d08SBarry Smith ierr = KSPGetOperators(snes->ksp,PETSC_NULL,PETSC_NULL,&matflag);CHKERRQ(ierr); 829aa3661deSLisandro Dalcin ierr = KSPSetOperators(snes->ksp,snes->jacobian,snes->jacobian_pre,matflag);CHKERRQ(ierr); 83085385478SLisandro Dalcin ierr = KSPSetFromOptions(snes->ksp);CHKERRQ(ierr); 83193993e2dSLois Curfman McInnes 8329e764e56SPeter Brune if (!snes->linesearch) { 833f1c6b773SPeter Brune ierr = SNESGetSNESLineSearch(snes, &snes->linesearch);CHKERRQ(ierr); 8349e764e56SPeter Brune } 835f1c6b773SPeter Brune ierr = SNESLineSearchSetFromOptions(snes->linesearch);CHKERRQ(ierr); 8369e764e56SPeter Brune 83751e86f29SPeter Brune /* if someone has set the SNES PC type, create it. */ 83851e86f29SPeter Brune ierr = SNESGetOptionsPrefix(snes, &optionsprefix);CHKERRQ(ierr); 83951e86f29SPeter Brune ierr = PetscOptionsHasName(optionsprefix, "-npc_snes_type", &pcset);CHKERRQ(ierr); 84051e86f29SPeter Brune if (pcset && (!snes->pc)) { 84151e86f29SPeter Brune ierr = SNESGetPC(snes, &snes->pc);CHKERRQ(ierr); 84251e86f29SPeter Brune } 8433a40ed3dSBarry Smith PetscFunctionReturn(0); 8449b94acceSBarry Smith } 8459b94acceSBarry Smith 846d25893d9SBarry Smith #undef __FUNCT__ 847d25893d9SBarry Smith #define __FUNCT__ "SNESSetComputeApplicationContext" 848d25893d9SBarry Smith /*@ 849d25893d9SBarry Smith SNESSetComputeApplicationContext - Sets an optional function to compute a user-defined context for 850d25893d9SBarry Smith the nonlinear solvers. 851d25893d9SBarry Smith 852d25893d9SBarry Smith Logically Collective on SNES 853d25893d9SBarry Smith 854d25893d9SBarry Smith Input Parameters: 855d25893d9SBarry Smith + snes - the SNES context 856d25893d9SBarry Smith . compute - function to compute the context 857d25893d9SBarry Smith - destroy - function to destroy the context 858d25893d9SBarry Smith 859d25893d9SBarry Smith Level: intermediate 860d25893d9SBarry Smith 861d25893d9SBarry Smith .keywords: SNES, nonlinear, set, application, context 862d25893d9SBarry Smith 863d25893d9SBarry Smith .seealso: SNESGetApplicationContext(), SNESSetComputeApplicationContext(), SNESGetApplicationContext() 864d25893d9SBarry Smith @*/ 865d25893d9SBarry Smith PetscErrorCode SNESSetComputeApplicationContext(SNES snes,PetscErrorCode (*compute)(SNES,void**),PetscErrorCode (*destroy)(void**)) 866d25893d9SBarry Smith { 867d25893d9SBarry Smith PetscFunctionBegin; 868d25893d9SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 869d25893d9SBarry Smith snes->ops->usercompute = compute; 870d25893d9SBarry Smith snes->ops->userdestroy = destroy; 871d25893d9SBarry Smith PetscFunctionReturn(0); 872d25893d9SBarry Smith } 873a847f771SSatish Balay 8744a2ae208SSatish Balay #undef __FUNCT__ 8754a2ae208SSatish Balay #define __FUNCT__ "SNESSetApplicationContext" 876b07ff414SBarry Smith /*@ 8779b94acceSBarry Smith SNESSetApplicationContext - Sets the optional user-defined context for 8789b94acceSBarry Smith the nonlinear solvers. 8799b94acceSBarry Smith 8803f9fe445SBarry Smith Logically Collective on SNES 881fee21e36SBarry Smith 882c7afd0dbSLois Curfman McInnes Input Parameters: 883c7afd0dbSLois Curfman McInnes + snes - the SNES context 884c7afd0dbSLois Curfman McInnes - usrP - optional user context 885c7afd0dbSLois Curfman McInnes 88636851e7fSLois Curfman McInnes Level: intermediate 88736851e7fSLois Curfman McInnes 8889b94acceSBarry Smith .keywords: SNES, nonlinear, set, application, context 8899b94acceSBarry Smith 890ecaffddaSVictor Eijkhout .seealso: SNESGetApplicationContext() 8919b94acceSBarry Smith @*/ 8927087cfbeSBarry Smith PetscErrorCode SNESSetApplicationContext(SNES snes,void *usrP) 8939b94acceSBarry Smith { 8941b2093e4SBarry Smith PetscErrorCode ierr; 895b07ff414SBarry Smith KSP ksp; 8961b2093e4SBarry Smith 8973a40ed3dSBarry Smith PetscFunctionBegin; 8980700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 899b07ff414SBarry Smith ierr = SNESGetKSP(snes,&ksp);CHKERRQ(ierr); 900b07ff414SBarry Smith ierr = KSPSetApplicationContext(ksp,usrP);CHKERRQ(ierr); 9019b94acceSBarry Smith snes->user = usrP; 9023a40ed3dSBarry Smith PetscFunctionReturn(0); 9039b94acceSBarry Smith } 90474679c65SBarry Smith 9054a2ae208SSatish Balay #undef __FUNCT__ 9064a2ae208SSatish Balay #define __FUNCT__ "SNESGetApplicationContext" 907b07ff414SBarry Smith /*@ 9089b94acceSBarry Smith SNESGetApplicationContext - Gets the user-defined context for the 9099b94acceSBarry Smith nonlinear solvers. 9109b94acceSBarry Smith 911c7afd0dbSLois Curfman McInnes Not Collective 912c7afd0dbSLois Curfman McInnes 9139b94acceSBarry Smith Input Parameter: 9149b94acceSBarry Smith . snes - SNES context 9159b94acceSBarry Smith 9169b94acceSBarry Smith Output Parameter: 9179b94acceSBarry Smith . usrP - user context 9189b94acceSBarry Smith 91936851e7fSLois Curfman McInnes Level: intermediate 92036851e7fSLois Curfman McInnes 9219b94acceSBarry Smith .keywords: SNES, nonlinear, get, application, context 9229b94acceSBarry Smith 9239b94acceSBarry Smith .seealso: SNESSetApplicationContext() 9249b94acceSBarry Smith @*/ 925e71120c6SJed Brown PetscErrorCode SNESGetApplicationContext(SNES snes,void *usrP) 9269b94acceSBarry Smith { 9273a40ed3dSBarry Smith PetscFunctionBegin; 9280700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 929e71120c6SJed Brown *(void**)usrP = snes->user; 9303a40ed3dSBarry Smith PetscFunctionReturn(0); 9319b94acceSBarry Smith } 93274679c65SBarry Smith 9334a2ae208SSatish Balay #undef __FUNCT__ 9344a2ae208SSatish Balay #define __FUNCT__ "SNESGetIterationNumber" 9359b94acceSBarry Smith /*@ 936c8228a4eSBarry Smith SNESGetIterationNumber - Gets the number of nonlinear iterations completed 937c8228a4eSBarry Smith at this time. 9389b94acceSBarry Smith 939c7afd0dbSLois Curfman McInnes Not Collective 940c7afd0dbSLois Curfman McInnes 9419b94acceSBarry Smith Input Parameter: 9429b94acceSBarry Smith . snes - SNES context 9439b94acceSBarry Smith 9449b94acceSBarry Smith Output Parameter: 9459b94acceSBarry Smith . iter - iteration number 9469b94acceSBarry Smith 947c8228a4eSBarry Smith Notes: 948c8228a4eSBarry Smith For example, during the computation of iteration 2 this would return 1. 949c8228a4eSBarry Smith 950c8228a4eSBarry Smith This is useful for using lagged Jacobians (where one does not recompute the 95108405cd6SLois Curfman McInnes Jacobian at each SNES iteration). For example, the code 95208405cd6SLois Curfman McInnes .vb 95308405cd6SLois Curfman McInnes ierr = SNESGetIterationNumber(snes,&it); 95408405cd6SLois Curfman McInnes if (!(it % 2)) { 95508405cd6SLois Curfman McInnes [compute Jacobian here] 95608405cd6SLois Curfman McInnes } 95708405cd6SLois Curfman McInnes .ve 958c8228a4eSBarry Smith can be used in your ComputeJacobian() function to cause the Jacobian to be 95908405cd6SLois Curfman McInnes recomputed every second SNES iteration. 960c8228a4eSBarry Smith 96136851e7fSLois Curfman McInnes Level: intermediate 96236851e7fSLois Curfman McInnes 9632b668275SBarry Smith .keywords: SNES, nonlinear, get, iteration, number, 9642b668275SBarry Smith 965b850b91aSLisandro Dalcin .seealso: SNESGetFunctionNorm(), SNESGetLinearSolveIterations() 9669b94acceSBarry Smith @*/ 9677087cfbeSBarry Smith PetscErrorCode SNESGetIterationNumber(SNES snes,PetscInt* iter) 9689b94acceSBarry Smith { 9693a40ed3dSBarry Smith PetscFunctionBegin; 9700700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 9714482741eSBarry Smith PetscValidIntPointer(iter,2); 9729b94acceSBarry Smith *iter = snes->iter; 9733a40ed3dSBarry Smith PetscFunctionReturn(0); 9749b94acceSBarry Smith } 97574679c65SBarry Smith 9764a2ae208SSatish Balay #undef __FUNCT__ 977360c497dSPeter Brune #define __FUNCT__ "SNESSetIterationNumber" 978360c497dSPeter Brune /*@ 979360c497dSPeter Brune SNESSetIterationNumber - Sets the current iteration number. 980360c497dSPeter Brune 981360c497dSPeter Brune Not Collective 982360c497dSPeter Brune 983360c497dSPeter Brune Input Parameter: 984360c497dSPeter Brune . snes - SNES context 985360c497dSPeter Brune . iter - iteration number 986360c497dSPeter Brune 987360c497dSPeter Brune Level: developer 988360c497dSPeter Brune 989360c497dSPeter Brune .keywords: SNES, nonlinear, set, iteration, number, 990360c497dSPeter Brune 991360c497dSPeter Brune .seealso: SNESGetFunctionNorm(), SNESGetLinearSolveIterations() 992360c497dSPeter Brune @*/ 993360c497dSPeter Brune PetscErrorCode SNESSetIterationNumber(SNES snes,PetscInt iter) 994360c497dSPeter Brune { 995360c497dSPeter Brune PetscErrorCode ierr; 996360c497dSPeter Brune 997360c497dSPeter Brune PetscFunctionBegin; 998360c497dSPeter Brune PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 999360c497dSPeter Brune ierr = PetscObjectTakeAccess(snes);CHKERRQ(ierr); 1000360c497dSPeter Brune snes->iter = iter; 1001360c497dSPeter Brune ierr = PetscObjectGrantAccess(snes);CHKERRQ(ierr); 1002360c497dSPeter Brune PetscFunctionReturn(0); 1003360c497dSPeter Brune } 1004360c497dSPeter Brune 1005360c497dSPeter Brune #undef __FUNCT__ 10064a2ae208SSatish Balay #define __FUNCT__ "SNESGetFunctionNorm" 10079b94acceSBarry Smith /*@ 10089b94acceSBarry Smith SNESGetFunctionNorm - Gets the norm of the current function that was set 10099b94acceSBarry Smith with SNESSSetFunction(). 10109b94acceSBarry Smith 1011c7afd0dbSLois Curfman McInnes Collective on SNES 1012c7afd0dbSLois Curfman McInnes 10139b94acceSBarry Smith Input Parameter: 10149b94acceSBarry Smith . snes - SNES context 10159b94acceSBarry Smith 10169b94acceSBarry Smith Output Parameter: 10179b94acceSBarry Smith . fnorm - 2-norm of function 10189b94acceSBarry Smith 101936851e7fSLois Curfman McInnes Level: intermediate 102036851e7fSLois Curfman McInnes 10219b94acceSBarry Smith .keywords: SNES, nonlinear, get, function, norm 1022a86d99e1SLois Curfman McInnes 1023b850b91aSLisandro Dalcin .seealso: SNESGetFunction(), SNESGetIterationNumber(), SNESGetLinearSolveIterations() 10249b94acceSBarry Smith @*/ 10257087cfbeSBarry Smith PetscErrorCode SNESGetFunctionNorm(SNES snes,PetscReal *fnorm) 10269b94acceSBarry Smith { 10273a40ed3dSBarry Smith PetscFunctionBegin; 10280700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 10294482741eSBarry Smith PetscValidScalarPointer(fnorm,2); 10309b94acceSBarry Smith *fnorm = snes->norm; 10313a40ed3dSBarry Smith PetscFunctionReturn(0); 10329b94acceSBarry Smith } 103374679c65SBarry Smith 1034360c497dSPeter Brune 1035360c497dSPeter Brune #undef __FUNCT__ 1036360c497dSPeter Brune #define __FUNCT__ "SNESSetFunctionNorm" 1037360c497dSPeter Brune /*@ 1038360c497dSPeter Brune SNESSetFunctionNorm - Sets the 2-norm of the current function computed using VecNorm(). 1039360c497dSPeter Brune 1040360c497dSPeter Brune Collective on SNES 1041360c497dSPeter Brune 1042360c497dSPeter Brune Input Parameter: 1043360c497dSPeter Brune . snes - SNES context 1044360c497dSPeter Brune . fnorm - 2-norm of function 1045360c497dSPeter Brune 1046360c497dSPeter Brune Level: developer 1047360c497dSPeter Brune 1048360c497dSPeter Brune .keywords: SNES, nonlinear, set, function, norm 1049360c497dSPeter Brune 1050360c497dSPeter Brune .seealso: SNESSetFunction(), SNESSetIterationNumber(), VecNorm(). 1051360c497dSPeter Brune @*/ 1052360c497dSPeter Brune PetscErrorCode SNESSetFunctionNorm(SNES snes,PetscReal fnorm) 1053360c497dSPeter Brune { 1054360c497dSPeter Brune 1055360c497dSPeter Brune PetscErrorCode ierr; 1056360c497dSPeter Brune 1057360c497dSPeter Brune PetscFunctionBegin; 1058360c497dSPeter Brune PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 1059360c497dSPeter Brune ierr = PetscObjectTakeAccess(snes);CHKERRQ(ierr); 1060360c497dSPeter Brune snes->norm = fnorm; 1061360c497dSPeter Brune ierr = PetscObjectGrantAccess(snes);CHKERRQ(ierr); 1062360c497dSPeter Brune PetscFunctionReturn(0); 1063360c497dSPeter Brune } 1064360c497dSPeter Brune 10654a2ae208SSatish Balay #undef __FUNCT__ 1066b850b91aSLisandro Dalcin #define __FUNCT__ "SNESGetNonlinearStepFailures" 10679b94acceSBarry Smith /*@ 1068b850b91aSLisandro Dalcin SNESGetNonlinearStepFailures - Gets the number of unsuccessful steps 10699b94acceSBarry Smith attempted by the nonlinear solver. 10709b94acceSBarry Smith 1071c7afd0dbSLois Curfman McInnes Not Collective 1072c7afd0dbSLois Curfman McInnes 10739b94acceSBarry Smith Input Parameter: 10749b94acceSBarry Smith . snes - SNES context 10759b94acceSBarry Smith 10769b94acceSBarry Smith Output Parameter: 10779b94acceSBarry Smith . nfails - number of unsuccessful steps attempted 10789b94acceSBarry Smith 1079c96a6f78SLois Curfman McInnes Notes: 1080c96a6f78SLois Curfman McInnes This counter is reset to zero for each successive call to SNESSolve(). 1081c96a6f78SLois Curfman McInnes 108236851e7fSLois Curfman McInnes Level: intermediate 108336851e7fSLois Curfman McInnes 10849b94acceSBarry Smith .keywords: SNES, nonlinear, get, number, unsuccessful, steps 108558ebbce7SBarry Smith 1086e1c61ce8SBarry Smith .seealso: SNESGetMaxLinearSolveFailures(), SNESGetLinearSolveIterations(), SNESSetMaxLinearSolveFailures(), SNESGetLinearSolveFailures(), 108758ebbce7SBarry Smith SNESSetMaxNonlinearStepFailures(), SNESGetMaxNonlinearStepFailures() 10889b94acceSBarry Smith @*/ 10897087cfbeSBarry Smith PetscErrorCode SNESGetNonlinearStepFailures(SNES snes,PetscInt* nfails) 10909b94acceSBarry Smith { 10913a40ed3dSBarry Smith PetscFunctionBegin; 10920700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 10934482741eSBarry Smith PetscValidIntPointer(nfails,2); 109450ffb88aSMatthew Knepley *nfails = snes->numFailures; 109550ffb88aSMatthew Knepley PetscFunctionReturn(0); 109650ffb88aSMatthew Knepley } 109750ffb88aSMatthew Knepley 109850ffb88aSMatthew Knepley #undef __FUNCT__ 1099b850b91aSLisandro Dalcin #define __FUNCT__ "SNESSetMaxNonlinearStepFailures" 110050ffb88aSMatthew Knepley /*@ 1101b850b91aSLisandro Dalcin SNESSetMaxNonlinearStepFailures - Sets the maximum number of unsuccessful steps 110250ffb88aSMatthew Knepley attempted by the nonlinear solver before it gives up. 110350ffb88aSMatthew Knepley 110450ffb88aSMatthew Knepley Not Collective 110550ffb88aSMatthew Knepley 110650ffb88aSMatthew Knepley Input Parameters: 110750ffb88aSMatthew Knepley + snes - SNES context 110850ffb88aSMatthew Knepley - maxFails - maximum of unsuccessful steps 110950ffb88aSMatthew Knepley 111050ffb88aSMatthew Knepley Level: intermediate 111150ffb88aSMatthew Knepley 111250ffb88aSMatthew Knepley .keywords: SNES, nonlinear, set, maximum, unsuccessful, steps 111358ebbce7SBarry Smith 1114e1c61ce8SBarry Smith .seealso: SNESGetMaxLinearSolveFailures(), SNESGetLinearSolveIterations(), SNESSetMaxLinearSolveFailures(), SNESGetLinearSolveFailures(), 111558ebbce7SBarry Smith SNESGetMaxNonlinearStepFailures(), SNESGetNonlinearStepFailures() 111650ffb88aSMatthew Knepley @*/ 11177087cfbeSBarry Smith PetscErrorCode SNESSetMaxNonlinearStepFailures(SNES snes, PetscInt maxFails) 111850ffb88aSMatthew Knepley { 111950ffb88aSMatthew Knepley PetscFunctionBegin; 11200700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 112150ffb88aSMatthew Knepley snes->maxFailures = maxFails; 112250ffb88aSMatthew Knepley PetscFunctionReturn(0); 112350ffb88aSMatthew Knepley } 112450ffb88aSMatthew Knepley 112550ffb88aSMatthew Knepley #undef __FUNCT__ 1126b850b91aSLisandro Dalcin #define __FUNCT__ "SNESGetMaxNonlinearStepFailures" 112750ffb88aSMatthew Knepley /*@ 1128b850b91aSLisandro Dalcin SNESGetMaxNonlinearStepFailures - Gets the maximum number of unsuccessful steps 112950ffb88aSMatthew Knepley attempted by the nonlinear solver before it gives up. 113050ffb88aSMatthew Knepley 113150ffb88aSMatthew Knepley Not Collective 113250ffb88aSMatthew Knepley 113350ffb88aSMatthew Knepley Input Parameter: 113450ffb88aSMatthew Knepley . snes - SNES context 113550ffb88aSMatthew Knepley 113650ffb88aSMatthew Knepley Output Parameter: 113750ffb88aSMatthew Knepley . maxFails - maximum of unsuccessful steps 113850ffb88aSMatthew Knepley 113950ffb88aSMatthew Knepley Level: intermediate 114050ffb88aSMatthew Knepley 114150ffb88aSMatthew Knepley .keywords: SNES, nonlinear, get, maximum, unsuccessful, steps 114258ebbce7SBarry Smith 1143e1c61ce8SBarry Smith .seealso: SNESGetMaxLinearSolveFailures(), SNESGetLinearSolveIterations(), SNESSetMaxLinearSolveFailures(), SNESGetLinearSolveFailures(), 114458ebbce7SBarry Smith SNESSetMaxNonlinearStepFailures(), SNESGetNonlinearStepFailures() 114558ebbce7SBarry Smith 114650ffb88aSMatthew Knepley @*/ 11477087cfbeSBarry Smith PetscErrorCode SNESGetMaxNonlinearStepFailures(SNES snes, PetscInt *maxFails) 114850ffb88aSMatthew Knepley { 114950ffb88aSMatthew Knepley PetscFunctionBegin; 11500700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 11514482741eSBarry Smith PetscValidIntPointer(maxFails,2); 115250ffb88aSMatthew Knepley *maxFails = snes->maxFailures; 11533a40ed3dSBarry Smith PetscFunctionReturn(0); 11549b94acceSBarry Smith } 1155a847f771SSatish Balay 11564a2ae208SSatish Balay #undef __FUNCT__ 11572541af92SBarry Smith #define __FUNCT__ "SNESGetNumberFunctionEvals" 11582541af92SBarry Smith /*@ 11592541af92SBarry Smith SNESGetNumberFunctionEvals - Gets the number of user provided function evaluations 11602541af92SBarry Smith done by SNES. 11612541af92SBarry Smith 11622541af92SBarry Smith Not Collective 11632541af92SBarry Smith 11642541af92SBarry Smith Input Parameter: 11652541af92SBarry Smith . snes - SNES context 11662541af92SBarry Smith 11672541af92SBarry Smith Output Parameter: 11682541af92SBarry Smith . nfuncs - number of evaluations 11692541af92SBarry Smith 11702541af92SBarry Smith Level: intermediate 11712541af92SBarry Smith 11722541af92SBarry Smith .keywords: SNES, nonlinear, get, maximum, unsuccessful, steps 117358ebbce7SBarry Smith 1174e1c61ce8SBarry Smith .seealso: SNESGetMaxLinearSolveFailures(), SNESGetLinearSolveIterations(), SNESSetMaxLinearSolveFailures(), SNESGetLinearSolveFailures() 11752541af92SBarry Smith @*/ 11767087cfbeSBarry Smith PetscErrorCode SNESGetNumberFunctionEvals(SNES snes, PetscInt *nfuncs) 11772541af92SBarry Smith { 11782541af92SBarry Smith PetscFunctionBegin; 11790700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 11802541af92SBarry Smith PetscValidIntPointer(nfuncs,2); 11812541af92SBarry Smith *nfuncs = snes->nfuncs; 11822541af92SBarry Smith PetscFunctionReturn(0); 11832541af92SBarry Smith } 11842541af92SBarry Smith 11852541af92SBarry Smith #undef __FUNCT__ 11863d4c4710SBarry Smith #define __FUNCT__ "SNESGetLinearSolveFailures" 11873d4c4710SBarry Smith /*@ 11883d4c4710SBarry Smith SNESGetLinearSolveFailures - Gets the number of failed (non-converged) 11893d4c4710SBarry Smith linear solvers. 11903d4c4710SBarry Smith 11913d4c4710SBarry Smith Not Collective 11923d4c4710SBarry Smith 11933d4c4710SBarry Smith Input Parameter: 11943d4c4710SBarry Smith . snes - SNES context 11953d4c4710SBarry Smith 11963d4c4710SBarry Smith Output Parameter: 11973d4c4710SBarry Smith . nfails - number of failed solves 11983d4c4710SBarry Smith 11993d4c4710SBarry Smith Notes: 12003d4c4710SBarry Smith This counter is reset to zero for each successive call to SNESSolve(). 12013d4c4710SBarry Smith 12023d4c4710SBarry Smith Level: intermediate 12033d4c4710SBarry Smith 12043d4c4710SBarry Smith .keywords: SNES, nonlinear, get, number, unsuccessful, steps 120558ebbce7SBarry Smith 1206e1c61ce8SBarry Smith .seealso: SNESGetMaxLinearSolveFailures(), SNESGetLinearSolveIterations(), SNESSetMaxLinearSolveFailures() 12073d4c4710SBarry Smith @*/ 12087087cfbeSBarry Smith PetscErrorCode SNESGetLinearSolveFailures(SNES snes,PetscInt* nfails) 12093d4c4710SBarry Smith { 12103d4c4710SBarry Smith PetscFunctionBegin; 12110700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 12123d4c4710SBarry Smith PetscValidIntPointer(nfails,2); 12133d4c4710SBarry Smith *nfails = snes->numLinearSolveFailures; 12143d4c4710SBarry Smith PetscFunctionReturn(0); 12153d4c4710SBarry Smith } 12163d4c4710SBarry Smith 12173d4c4710SBarry Smith #undef __FUNCT__ 12183d4c4710SBarry Smith #define __FUNCT__ "SNESSetMaxLinearSolveFailures" 12193d4c4710SBarry Smith /*@ 12203d4c4710SBarry Smith SNESSetMaxLinearSolveFailures - the number of failed linear solve attempts 12213d4c4710SBarry Smith allowed before SNES returns with a diverged reason of SNES_DIVERGED_LINEAR_SOLVE 12223d4c4710SBarry Smith 12233f9fe445SBarry Smith Logically Collective on SNES 12243d4c4710SBarry Smith 12253d4c4710SBarry Smith Input Parameters: 12263d4c4710SBarry Smith + snes - SNES context 12273d4c4710SBarry Smith - maxFails - maximum allowed linear solve failures 12283d4c4710SBarry Smith 12293d4c4710SBarry Smith Level: intermediate 12303d4c4710SBarry Smith 1231a6796414SBarry Smith Notes: By default this is 0; that is SNES returns on the first failed linear solve 12323d4c4710SBarry Smith 12333d4c4710SBarry Smith .keywords: SNES, nonlinear, set, maximum, unsuccessful, steps 12343d4c4710SBarry Smith 123558ebbce7SBarry Smith .seealso: SNESGetLinearSolveFailures(), SNESGetMaxLinearSolveFailures(), SNESGetLinearSolveIterations() 12363d4c4710SBarry Smith @*/ 12377087cfbeSBarry Smith PetscErrorCode SNESSetMaxLinearSolveFailures(SNES snes, PetscInt maxFails) 12383d4c4710SBarry Smith { 12393d4c4710SBarry Smith PetscFunctionBegin; 12400700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 1241c5eb9154SBarry Smith PetscValidLogicalCollectiveInt(snes,maxFails,2); 12423d4c4710SBarry Smith snes->maxLinearSolveFailures = maxFails; 12433d4c4710SBarry Smith PetscFunctionReturn(0); 12443d4c4710SBarry Smith } 12453d4c4710SBarry Smith 12463d4c4710SBarry Smith #undef __FUNCT__ 12473d4c4710SBarry Smith #define __FUNCT__ "SNESGetMaxLinearSolveFailures" 12483d4c4710SBarry Smith /*@ 12493d4c4710SBarry Smith SNESGetMaxLinearSolveFailures - gets the maximum number of linear solve failures that 12503d4c4710SBarry Smith are allowed before SNES terminates 12513d4c4710SBarry Smith 12523d4c4710SBarry Smith Not Collective 12533d4c4710SBarry Smith 12543d4c4710SBarry Smith Input Parameter: 12553d4c4710SBarry Smith . snes - SNES context 12563d4c4710SBarry Smith 12573d4c4710SBarry Smith Output Parameter: 12583d4c4710SBarry Smith . maxFails - maximum of unsuccessful solves allowed 12593d4c4710SBarry Smith 12603d4c4710SBarry Smith Level: intermediate 12613d4c4710SBarry Smith 12623d4c4710SBarry Smith Notes: By default this is 1; that is SNES returns on the first failed linear solve 12633d4c4710SBarry Smith 12643d4c4710SBarry Smith .keywords: SNES, nonlinear, get, maximum, unsuccessful, steps 12653d4c4710SBarry Smith 1266e1c61ce8SBarry Smith .seealso: SNESGetLinearSolveFailures(), SNESGetLinearSolveIterations(), SNESSetMaxLinearSolveFailures(), 12673d4c4710SBarry Smith @*/ 12687087cfbeSBarry Smith PetscErrorCode SNESGetMaxLinearSolveFailures(SNES snes, PetscInt *maxFails) 12693d4c4710SBarry Smith { 12703d4c4710SBarry Smith PetscFunctionBegin; 12710700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 12723d4c4710SBarry Smith PetscValidIntPointer(maxFails,2); 12733d4c4710SBarry Smith *maxFails = snes->maxLinearSolveFailures; 12743d4c4710SBarry Smith PetscFunctionReturn(0); 12753d4c4710SBarry Smith } 12763d4c4710SBarry Smith 12773d4c4710SBarry Smith #undef __FUNCT__ 1278b850b91aSLisandro Dalcin #define __FUNCT__ "SNESGetLinearSolveIterations" 1279c96a6f78SLois Curfman McInnes /*@ 1280b850b91aSLisandro Dalcin SNESGetLinearSolveIterations - Gets the total number of linear iterations 1281c96a6f78SLois Curfman McInnes used by the nonlinear solver. 1282c96a6f78SLois Curfman McInnes 1283c7afd0dbSLois Curfman McInnes Not Collective 1284c7afd0dbSLois Curfman McInnes 1285c96a6f78SLois Curfman McInnes Input Parameter: 1286c96a6f78SLois Curfman McInnes . snes - SNES context 1287c96a6f78SLois Curfman McInnes 1288c96a6f78SLois Curfman McInnes Output Parameter: 1289c96a6f78SLois Curfman McInnes . lits - number of linear iterations 1290c96a6f78SLois Curfman McInnes 1291c96a6f78SLois Curfman McInnes Notes: 1292c96a6f78SLois Curfman McInnes This counter is reset to zero for each successive call to SNESSolve(). 1293c96a6f78SLois Curfman McInnes 129436851e7fSLois Curfman McInnes Level: intermediate 129536851e7fSLois Curfman McInnes 1296c96a6f78SLois Curfman McInnes .keywords: SNES, nonlinear, get, number, linear, iterations 12972b668275SBarry Smith 12988c7482ecSBarry Smith .seealso: SNESGetIterationNumber(), SNESGetFunctionNorm(), SNESGetLinearSolveFailures(), SNESGetMaxLinearSolveFailures() 1299c96a6f78SLois Curfman McInnes @*/ 13007087cfbeSBarry Smith PetscErrorCode SNESGetLinearSolveIterations(SNES snes,PetscInt* lits) 1301c96a6f78SLois Curfman McInnes { 13023a40ed3dSBarry Smith PetscFunctionBegin; 13030700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 13044482741eSBarry Smith PetscValidIntPointer(lits,2); 1305c96a6f78SLois Curfman McInnes *lits = snes->linear_its; 13063a40ed3dSBarry Smith PetscFunctionReturn(0); 1307c96a6f78SLois Curfman McInnes } 1308c96a6f78SLois Curfman McInnes 13094a2ae208SSatish Balay #undef __FUNCT__ 131094b7f48cSBarry Smith #define __FUNCT__ "SNESGetKSP" 131152baeb72SSatish Balay /*@ 131294b7f48cSBarry Smith SNESGetKSP - Returns the KSP context for a SNES solver. 13139b94acceSBarry Smith 131494b7f48cSBarry Smith Not Collective, but if SNES object is parallel, then KSP object is parallel 1315c7afd0dbSLois Curfman McInnes 13169b94acceSBarry Smith Input Parameter: 13179b94acceSBarry Smith . snes - the SNES context 13189b94acceSBarry Smith 13199b94acceSBarry Smith Output Parameter: 132094b7f48cSBarry Smith . ksp - the KSP context 13219b94acceSBarry Smith 13229b94acceSBarry Smith Notes: 132394b7f48cSBarry Smith The user can then directly manipulate the KSP context to set various 13249b94acceSBarry Smith options, etc. Likewise, the user can then extract and manipulate the 13252999313aSBarry Smith PC contexts as well. 13269b94acceSBarry Smith 132736851e7fSLois Curfman McInnes Level: beginner 132836851e7fSLois Curfman McInnes 132994b7f48cSBarry Smith .keywords: SNES, nonlinear, get, KSP, context 13309b94acceSBarry Smith 13312999313aSBarry Smith .seealso: KSPGetPC(), SNESCreate(), KSPCreate(), SNESSetKSP() 13329b94acceSBarry Smith @*/ 13337087cfbeSBarry Smith PetscErrorCode SNESGetKSP(SNES snes,KSP *ksp) 13349b94acceSBarry Smith { 13351cee3971SBarry Smith PetscErrorCode ierr; 13361cee3971SBarry Smith 13373a40ed3dSBarry Smith PetscFunctionBegin; 13380700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 13394482741eSBarry Smith PetscValidPointer(ksp,2); 13401cee3971SBarry Smith 13411cee3971SBarry Smith if (!snes->ksp) { 13421cee3971SBarry Smith ierr = KSPCreate(((PetscObject)snes)->comm,&snes->ksp);CHKERRQ(ierr); 13431cee3971SBarry Smith ierr = PetscObjectIncrementTabLevel((PetscObject)snes->ksp,(PetscObject)snes,1);CHKERRQ(ierr); 13441cee3971SBarry Smith ierr = PetscLogObjectParent(snes,snes->ksp);CHKERRQ(ierr); 13451cee3971SBarry Smith } 134694b7f48cSBarry Smith *ksp = snes->ksp; 13473a40ed3dSBarry Smith PetscFunctionReturn(0); 13489b94acceSBarry Smith } 134982bf6240SBarry Smith 13504a2ae208SSatish Balay #undef __FUNCT__ 13512999313aSBarry Smith #define __FUNCT__ "SNESSetKSP" 13522999313aSBarry Smith /*@ 13532999313aSBarry Smith SNESSetKSP - Sets a KSP context for the SNES object to use 13542999313aSBarry Smith 13552999313aSBarry Smith Not Collective, but the SNES and KSP objects must live on the same MPI_Comm 13562999313aSBarry Smith 13572999313aSBarry Smith Input Parameters: 13582999313aSBarry Smith + snes - the SNES context 13592999313aSBarry Smith - ksp - the KSP context 13602999313aSBarry Smith 13612999313aSBarry Smith Notes: 13622999313aSBarry Smith The SNES object already has its KSP object, you can obtain with SNESGetKSP() 13632999313aSBarry Smith so this routine is rarely needed. 13642999313aSBarry Smith 13652999313aSBarry Smith The KSP object that is already in the SNES object has its reference count 13662999313aSBarry Smith decreased by one. 13672999313aSBarry Smith 13682999313aSBarry Smith Level: developer 13692999313aSBarry Smith 13702999313aSBarry Smith .keywords: SNES, nonlinear, get, KSP, context 13712999313aSBarry Smith 13722999313aSBarry Smith .seealso: KSPGetPC(), SNESCreate(), KSPCreate(), SNESSetKSP() 13732999313aSBarry Smith @*/ 13747087cfbeSBarry Smith PetscErrorCode SNESSetKSP(SNES snes,KSP ksp) 13752999313aSBarry Smith { 13762999313aSBarry Smith PetscErrorCode ierr; 13772999313aSBarry Smith 13782999313aSBarry Smith PetscFunctionBegin; 13790700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 13800700a824SBarry Smith PetscValidHeaderSpecific(ksp,KSP_CLASSID,2); 13812999313aSBarry Smith PetscCheckSameComm(snes,1,ksp,2); 13827dcf0eaaSdalcinl ierr = PetscObjectReference((PetscObject)ksp);CHKERRQ(ierr); 1383906ed7ccSBarry Smith if (snes->ksp) {ierr = PetscObjectDereference((PetscObject)snes->ksp);CHKERRQ(ierr);} 13842999313aSBarry Smith snes->ksp = ksp; 13852999313aSBarry Smith PetscFunctionReturn(0); 13862999313aSBarry Smith } 13872999313aSBarry Smith 13887adad957SLisandro Dalcin #if 0 13892999313aSBarry Smith #undef __FUNCT__ 13904a2ae208SSatish Balay #define __FUNCT__ "SNESPublish_Petsc" 13916849ba73SBarry Smith static PetscErrorCode SNESPublish_Petsc(PetscObject obj) 1392e24b481bSBarry Smith { 1393e24b481bSBarry Smith PetscFunctionBegin; 1394e24b481bSBarry Smith PetscFunctionReturn(0); 1395e24b481bSBarry Smith } 13967adad957SLisandro Dalcin #endif 1397e24b481bSBarry Smith 13989b94acceSBarry Smith /* -----------------------------------------------------------*/ 13994a2ae208SSatish Balay #undef __FUNCT__ 14004a2ae208SSatish Balay #define __FUNCT__ "SNESCreate" 140152baeb72SSatish Balay /*@ 14029b94acceSBarry Smith SNESCreate - Creates a nonlinear solver context. 14039b94acceSBarry Smith 1404c7afd0dbSLois Curfman McInnes Collective on MPI_Comm 1405c7afd0dbSLois Curfman McInnes 1406c7afd0dbSLois Curfman McInnes Input Parameters: 1407906ed7ccSBarry Smith . comm - MPI communicator 14089b94acceSBarry Smith 14099b94acceSBarry Smith Output Parameter: 14109b94acceSBarry Smith . outsnes - the new SNES context 14119b94acceSBarry Smith 1412c7afd0dbSLois Curfman McInnes Options Database Keys: 1413c7afd0dbSLois Curfman McInnes + -snes_mf - Activates default matrix-free Jacobian-vector products, 1414c7afd0dbSLois Curfman McInnes and no preconditioning matrix 1415c7afd0dbSLois Curfman McInnes . -snes_mf_operator - Activates default matrix-free Jacobian-vector 1416c7afd0dbSLois Curfman McInnes products, and a user-provided preconditioning matrix 1417c7afd0dbSLois Curfman McInnes as set by SNESSetJacobian() 1418c7afd0dbSLois Curfman McInnes - -snes_fd - Uses (slow!) finite differences to compute Jacobian 1419c1f60f51SBarry Smith 142036851e7fSLois Curfman McInnes Level: beginner 142136851e7fSLois Curfman McInnes 14229b94acceSBarry Smith .keywords: SNES, nonlinear, create, context 14239b94acceSBarry Smith 1424a8054027SBarry Smith .seealso: SNESSolve(), SNESDestroy(), SNES, SNESSetLagPreconditioner() 1425a8054027SBarry Smith 14269b94acceSBarry Smith @*/ 14277087cfbeSBarry Smith PetscErrorCode SNESCreate(MPI_Comm comm,SNES *outsnes) 14289b94acceSBarry Smith { 1429dfbe8321SBarry Smith PetscErrorCode ierr; 14309b94acceSBarry Smith SNES snes; 1431fa9f3622SBarry Smith SNESKSPEW *kctx; 143237fcc0dbSBarry Smith 14333a40ed3dSBarry Smith PetscFunctionBegin; 1434ed1caa07SMatthew Knepley PetscValidPointer(outsnes,2); 14358ba1e511SMatthew Knepley *outsnes = PETSC_NULL; 14368ba1e511SMatthew Knepley #ifndef PETSC_USE_DYNAMIC_LIBRARIES 14378ba1e511SMatthew Knepley ierr = SNESInitializePackage(PETSC_NULL);CHKERRQ(ierr); 14388ba1e511SMatthew Knepley #endif 14398ba1e511SMatthew Knepley 14403194b578SJed Brown ierr = PetscHeaderCreate(snes,_p_SNES,struct _SNESOps,SNES_CLASSID,0,"SNES","Nonlinear solver","SNES",comm,SNESDestroy,SNESView);CHKERRQ(ierr); 14417adad957SLisandro Dalcin 144285385478SLisandro Dalcin snes->ops->converged = SNESDefaultConverged; 14432c155ee1SBarry Smith snes->usesksp = PETSC_TRUE; 144488976e71SPeter Brune snes->tolerancesset = PETSC_FALSE; 14459b94acceSBarry Smith snes->max_its = 50; 14469750a799SBarry Smith snes->max_funcs = 10000; 14479b94acceSBarry Smith snes->norm = 0.0; 1448fdacfa88SPeter Brune snes->normtype = SNES_NORM_FUNCTION; 1449b4874afaSBarry Smith snes->rtol = 1.e-8; 1450b4874afaSBarry Smith snes->ttol = 0.0; 145170441072SBarry Smith snes->abstol = 1.e-50; 1452c60f73f4SPeter Brune snes->stol = 1.e-8; 14534b27c08aSLois Curfman McInnes snes->deltatol = 1.e-12; 14549b94acceSBarry Smith snes->nfuncs = 0; 145550ffb88aSMatthew Knepley snes->numFailures = 0; 145650ffb88aSMatthew Knepley snes->maxFailures = 1; 14577a00f4a9SLois Curfman McInnes snes->linear_its = 0; 1458e35cf81dSBarry Smith snes->lagjacobian = 1; 1459a8054027SBarry Smith snes->lagpreconditioner = 1; 1460639f9d9dSBarry Smith snes->numbermonitors = 0; 14619b94acceSBarry Smith snes->data = 0; 14624dc4c822SBarry Smith snes->setupcalled = PETSC_FALSE; 1463186905e3SBarry Smith snes->ksp_ewconv = PETSC_FALSE; 14646f24a144SLois Curfman McInnes snes->nwork = 0; 146558c9b817SLisandro Dalcin snes->work = 0; 146658c9b817SLisandro Dalcin snes->nvwork = 0; 146758c9b817SLisandro Dalcin snes->vwork = 0; 1468758f92a0SBarry Smith snes->conv_hist_len = 0; 1469758f92a0SBarry Smith snes->conv_hist_max = 0; 1470758f92a0SBarry Smith snes->conv_hist = PETSC_NULL; 1471758f92a0SBarry Smith snes->conv_hist_its = PETSC_NULL; 1472758f92a0SBarry Smith snes->conv_hist_reset = PETSC_TRUE; 1473e4ed7901SPeter Brune snes->vec_func_init_set = PETSC_FALSE; 1474e4ed7901SPeter Brune snes->norm_init = 0.; 1475e4ed7901SPeter Brune snes->norm_init_set = PETSC_FALSE; 1476184914b5SBarry Smith snes->reason = SNES_CONVERGED_ITERATING; 147789b92e6fSPeter Brune snes->gssweeps = 1; 14789b94acceSBarry Smith 1479c40d0f55SPeter Brune snes->pcside = PC_RIGHT; 1480c40d0f55SPeter Brune 1481d8f46077SPeter Brune snes->mf = PETSC_FALSE; 1482d8f46077SPeter Brune snes->mf_operator = PETSC_FALSE; 1483d8f46077SPeter Brune snes->mf_version = 1; 1484d8f46077SPeter Brune 14853d4c4710SBarry Smith snes->numLinearSolveFailures = 0; 14863d4c4710SBarry Smith snes->maxLinearSolveFailures = 1; 14873d4c4710SBarry Smith 14889b94acceSBarry Smith /* Create context to compute Eisenstat-Walker relative tolerance for KSP */ 148938f2d2fdSLisandro Dalcin ierr = PetscNewLog(snes,SNESKSPEW,&kctx);CHKERRQ(ierr); 14909b94acceSBarry Smith snes->kspconvctx = (void*)kctx; 14919b94acceSBarry Smith kctx->version = 2; 14929b94acceSBarry Smith kctx->rtol_0 = .3; /* Eisenstat and Walker suggest rtol_0=.5, but 14939b94acceSBarry Smith this was too large for some test cases */ 149475567043SBarry Smith kctx->rtol_last = 0.0; 14959b94acceSBarry Smith kctx->rtol_max = .9; 14969b94acceSBarry Smith kctx->gamma = 1.0; 149762d1f40fSBarry Smith kctx->alpha = .5*(1.0 + PetscSqrtReal(5.0)); 149871f87433Sdalcinl kctx->alpha2 = kctx->alpha; 14999b94acceSBarry Smith kctx->threshold = .1; 150075567043SBarry Smith kctx->lresid_last = 0.0; 150175567043SBarry Smith kctx->norm_last = 0.0; 15029b94acceSBarry Smith 15039b94acceSBarry Smith *outsnes = snes; 15043a40ed3dSBarry Smith PetscFunctionReturn(0); 15059b94acceSBarry Smith } 15069b94acceSBarry Smith 150788f0584fSBarry Smith /*MC 150888f0584fSBarry Smith SNESFunction - function used to convey the nonlinear function to be solved by SNES 150988f0584fSBarry Smith 151088f0584fSBarry Smith Synopsis: 1511f2ba6396SBarry Smith #include "petscsnes.h" 151288f0584fSBarry Smith SNESFunction(SNES snes,Vec x,Vec f,void *ctx); 151388f0584fSBarry Smith 151488f0584fSBarry Smith Input Parameters: 151588f0584fSBarry Smith + snes - the SNES context 151688f0584fSBarry Smith . x - state at which to evaluate residual 151788f0584fSBarry Smith - ctx - optional user-defined function context, passed in with SNESSetFunction() 151888f0584fSBarry Smith 151988f0584fSBarry Smith Output Parameter: 152088f0584fSBarry Smith . f - vector to put residual (function value) 152188f0584fSBarry Smith 152288f0584fSBarry Smith .seealso: SNESSetFunction(), SNESGetFunction() 152388f0584fSBarry Smith M*/ 152488f0584fSBarry Smith 15254a2ae208SSatish Balay #undef __FUNCT__ 15264a2ae208SSatish Balay #define __FUNCT__ "SNESSetFunction" 15279b94acceSBarry Smith /*@C 15289b94acceSBarry Smith SNESSetFunction - Sets the function evaluation routine and function 15299b94acceSBarry Smith vector for use by the SNES routines in solving systems of nonlinear 15309b94acceSBarry Smith equations. 15319b94acceSBarry Smith 15323f9fe445SBarry Smith Logically Collective on SNES 1533fee21e36SBarry Smith 1534c7afd0dbSLois Curfman McInnes Input Parameters: 1535c7afd0dbSLois Curfman McInnes + snes - the SNES context 1536c7afd0dbSLois Curfman McInnes . r - vector to store function value 153788f0584fSBarry Smith . SNESFunction - function evaluation routine 1538c7afd0dbSLois Curfman McInnes - ctx - [optional] user-defined context for private data for the 1539c7afd0dbSLois Curfman McInnes function evaluation routine (may be PETSC_NULL) 15409b94acceSBarry Smith 15419b94acceSBarry Smith Notes: 15429b94acceSBarry Smith The Newton-like methods typically solve linear systems of the form 15439b94acceSBarry Smith $ f'(x) x = -f(x), 1544c7afd0dbSLois Curfman McInnes where f'(x) denotes the Jacobian matrix and f(x) is the function. 15459b94acceSBarry Smith 154636851e7fSLois Curfman McInnes Level: beginner 154736851e7fSLois Curfman McInnes 15489b94acceSBarry Smith .keywords: SNES, nonlinear, set, function 15499b94acceSBarry Smith 1550*bf388a1fSBarry Smith .seealso: SNESGetFunction(), SNESComputeFunction(), SNESSetJacobian(), SNESSetPicard(), SNESFunction 15519b94acceSBarry Smith @*/ 155288f0584fSBarry Smith PetscErrorCode SNESSetFunction(SNES snes,Vec r,PetscErrorCode (*SNESFunction)(SNES,Vec,Vec,void*),void *ctx) 15539b94acceSBarry Smith { 155485385478SLisandro Dalcin PetscErrorCode ierr; 15556cab3a1bSJed Brown DM dm; 15566cab3a1bSJed Brown 15573a40ed3dSBarry Smith PetscFunctionBegin; 15580700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 1559d2a683ecSLisandro Dalcin if (r) { 1560d2a683ecSLisandro Dalcin PetscValidHeaderSpecific(r,VEC_CLASSID,2); 1561d2a683ecSLisandro Dalcin PetscCheckSameComm(snes,1,r,2); 156285385478SLisandro Dalcin ierr = PetscObjectReference((PetscObject)r);CHKERRQ(ierr); 15636bf464f9SBarry Smith ierr = VecDestroy(&snes->vec_func);CHKERRQ(ierr); 156485385478SLisandro Dalcin snes->vec_func = r; 1565d2a683ecSLisandro Dalcin } 15666cab3a1bSJed Brown ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr); 156788f0584fSBarry Smith ierr = DMSNESSetFunction(dm,SNESFunction,ctx);CHKERRQ(ierr); 15683a40ed3dSBarry Smith PetscFunctionReturn(0); 15699b94acceSBarry Smith } 15709b94acceSBarry Smith 1571646217ecSPeter Brune 1572646217ecSPeter Brune #undef __FUNCT__ 1573e4ed7901SPeter Brune #define __FUNCT__ "SNESSetInitialFunction" 1574e4ed7901SPeter Brune /*@C 1575e4ed7901SPeter Brune SNESSetInitialFunction - Sets the function vector to be used as the 1576e4ed7901SPeter Brune function norm at the initialization of the method. In some 1577e4ed7901SPeter Brune instances, the user has precomputed the function before calling 1578e4ed7901SPeter Brune SNESSolve. This function allows one to avoid a redundant call 1579e4ed7901SPeter Brune to SNESComputeFunction in that case. 1580e4ed7901SPeter Brune 1581e4ed7901SPeter Brune Logically Collective on SNES 1582e4ed7901SPeter Brune 1583e4ed7901SPeter Brune Input Parameters: 1584e4ed7901SPeter Brune + snes - the SNES context 1585e4ed7901SPeter Brune - f - vector to store function value 1586e4ed7901SPeter Brune 1587e4ed7901SPeter Brune Notes: 1588e4ed7901SPeter Brune This should not be modified during the solution procedure. 1589e4ed7901SPeter Brune 1590e4ed7901SPeter Brune This is used extensively in the SNESFAS hierarchy and in nonlinear preconditioning. 1591e4ed7901SPeter Brune 1592e4ed7901SPeter Brune Level: developer 1593e4ed7901SPeter Brune 1594e4ed7901SPeter Brune .keywords: SNES, nonlinear, set, function 1595e4ed7901SPeter Brune 1596e4ed7901SPeter Brune .seealso: SNESSetFunction(), SNESComputeFunction(), SNESSetInitialFunctionNorm() 1597e4ed7901SPeter Brune @*/ 1598e4ed7901SPeter Brune PetscErrorCode SNESSetInitialFunction(SNES snes, Vec f) 1599e4ed7901SPeter Brune { 1600e4ed7901SPeter Brune PetscErrorCode ierr; 1601e4ed7901SPeter Brune Vec vec_func; 1602e4ed7901SPeter Brune 1603e4ed7901SPeter Brune PetscFunctionBegin; 1604e4ed7901SPeter Brune PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 1605e4ed7901SPeter Brune PetscValidHeaderSpecific(f,VEC_CLASSID,2); 1606e4ed7901SPeter Brune PetscCheckSameComm(snes,1,f,2); 1607e4ed7901SPeter Brune ierr = SNESGetFunction(snes,&vec_func,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr); 1608e4ed7901SPeter Brune ierr = VecCopy(f, vec_func);CHKERRQ(ierr); 1609217b9c2eSPeter Brune snes->vec_func_init_set = PETSC_TRUE; 1610e4ed7901SPeter Brune PetscFunctionReturn(0); 1611e4ed7901SPeter Brune } 1612e4ed7901SPeter Brune 1613e4ed7901SPeter Brune 1614e4ed7901SPeter Brune #undef __FUNCT__ 1615e4ed7901SPeter Brune #define __FUNCT__ "SNESSetInitialFunctionNorm" 1616e4ed7901SPeter Brune /*@C 1617e4ed7901SPeter Brune SNESSetInitialFunctionNorm - Sets the function norm to be used as the function norm 1618e4ed7901SPeter Brune at the initialization of the method. In some instances, the user has precomputed 1619e4ed7901SPeter Brune the function and its norm before calling SNESSolve. This function allows one to 1620e4ed7901SPeter Brune avoid a redundant call to SNESComputeFunction() and VecNorm() in that case. 1621e4ed7901SPeter Brune 1622e4ed7901SPeter Brune Logically Collective on SNES 1623e4ed7901SPeter Brune 1624e4ed7901SPeter Brune Input Parameters: 1625e4ed7901SPeter Brune + snes - the SNES context 1626e4ed7901SPeter Brune - fnorm - the norm of F as set by SNESSetInitialFunction() 1627e4ed7901SPeter Brune 1628e4ed7901SPeter Brune This is used extensively in the SNESFAS hierarchy and in nonlinear preconditioning. 1629e4ed7901SPeter Brune 1630e4ed7901SPeter Brune Level: developer 1631e4ed7901SPeter Brune 1632e4ed7901SPeter Brune .keywords: SNES, nonlinear, set, function, norm 1633e4ed7901SPeter Brune 1634e4ed7901SPeter Brune .seealso: SNESSetFunction(), SNESComputeFunction(), SNESSetInitialFunction() 1635e4ed7901SPeter Brune @*/ 1636e4ed7901SPeter Brune PetscErrorCode SNESSetInitialFunctionNorm(SNES snes, PetscReal fnorm) 1637e4ed7901SPeter Brune { 1638e4ed7901SPeter Brune PetscFunctionBegin; 1639e4ed7901SPeter Brune PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 1640e4ed7901SPeter Brune snes->norm_init = fnorm; 1641e4ed7901SPeter Brune snes->norm_init_set = PETSC_TRUE; 1642e4ed7901SPeter Brune PetscFunctionReturn(0); 1643e4ed7901SPeter Brune } 1644e4ed7901SPeter Brune 1645e4ed7901SPeter Brune #undef __FUNCT__ 1646534ebe21SPeter Brune #define __FUNCT__ "SNESSetNormType" 1647534ebe21SPeter Brune /*@ 1648534ebe21SPeter Brune SNESSetNormType - Sets the SNESNormType used in covergence and monitoring 1649534ebe21SPeter Brune of the SNES method. 1650534ebe21SPeter Brune 1651534ebe21SPeter Brune Logically Collective on SNES 1652534ebe21SPeter Brune 1653534ebe21SPeter Brune Input Parameters: 1654534ebe21SPeter Brune + snes - the SNES context 1655534ebe21SPeter Brune - normtype - the type of the norm used 1656534ebe21SPeter Brune 1657534ebe21SPeter Brune Notes: 1658534ebe21SPeter Brune Only certain SNES methods support certain SNESNormTypes. Most require evaluation 1659534ebe21SPeter Brune of the nonlinear function and the taking of its norm at every iteration to 1660534ebe21SPeter Brune even ensure convergence at all. However, methods such as custom Gauss-Seidel methods 1661534ebe21SPeter Brune (SNESGS) and the like do not require the norm of the function to be computed, and therfore 1662534ebe21SPeter Brune may either be monitored for convergence or not. As these are often used as nonlinear 1663534ebe21SPeter Brune preconditioners, monitoring the norm of their error is not a useful enterprise within 1664534ebe21SPeter Brune their solution. 1665534ebe21SPeter Brune 1666534ebe21SPeter Brune Level: developer 1667534ebe21SPeter Brune 1668534ebe21SPeter Brune .keywords: SNES, nonlinear, set, function, norm, type 1669534ebe21SPeter Brune 1670534ebe21SPeter Brune .seealso: SNESGetNormType(), SNESComputeFunction(), VecNorm(), SNESSetFunction(), SNESSetInitialFunction(), SNESNormType 1671534ebe21SPeter Brune @*/ 1672534ebe21SPeter Brune PetscErrorCode SNESSetNormType(SNES snes, SNESNormType normtype) 1673534ebe21SPeter Brune { 1674534ebe21SPeter Brune PetscFunctionBegin; 1675534ebe21SPeter Brune PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 1676534ebe21SPeter Brune snes->normtype = normtype; 1677534ebe21SPeter Brune PetscFunctionReturn(0); 1678534ebe21SPeter Brune } 1679534ebe21SPeter Brune 1680534ebe21SPeter Brune 1681534ebe21SPeter Brune #undef __FUNCT__ 1682534ebe21SPeter Brune #define __FUNCT__ "SNESGetNormType" 1683534ebe21SPeter Brune /*@ 1684534ebe21SPeter Brune SNESGetNormType - Gets the SNESNormType used in covergence and monitoring 1685534ebe21SPeter Brune of the SNES method. 1686534ebe21SPeter Brune 1687534ebe21SPeter Brune Logically Collective on SNES 1688534ebe21SPeter Brune 1689534ebe21SPeter Brune Input Parameters: 1690534ebe21SPeter Brune + snes - the SNES context 1691534ebe21SPeter Brune - normtype - the type of the norm used 1692534ebe21SPeter Brune 1693534ebe21SPeter Brune Level: advanced 1694534ebe21SPeter Brune 1695534ebe21SPeter Brune .keywords: SNES, nonlinear, set, function, norm, type 1696534ebe21SPeter Brune 1697534ebe21SPeter Brune .seealso: SNESSetNormType(), SNESComputeFunction(), VecNorm(), SNESSetFunction(), SNESSetInitialFunction(), SNESNormType 1698534ebe21SPeter Brune @*/ 1699534ebe21SPeter Brune PetscErrorCode SNESGetNormType(SNES snes, SNESNormType *normtype) 1700534ebe21SPeter Brune { 1701534ebe21SPeter Brune PetscFunctionBegin; 1702534ebe21SPeter Brune PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 1703534ebe21SPeter Brune *normtype = snes->normtype; 1704534ebe21SPeter Brune PetscFunctionReturn(0); 1705534ebe21SPeter Brune } 1706534ebe21SPeter Brune 1707*bf388a1fSBarry Smith /*MC 1708*bf388a1fSBarry Smith SNESGSFunction - function used to convey a Gauss-Seidel sweep on the nonlinear function 1709*bf388a1fSBarry Smith 1710*bf388a1fSBarry Smith Synopsis: 1711*bf388a1fSBarry Smith #include "petscsnes.h" 1712*bf388a1fSBarry Smith $ SNESGSFunction(SNES snes,Vec x,Vec b,void *ctx); 1713*bf388a1fSBarry Smith 1714*bf388a1fSBarry Smith + X - solution vector 1715*bf388a1fSBarry Smith . B - RHS vector 1716*bf388a1fSBarry Smith - ctx - optional user-defined Gauss-Seidel context 1717*bf388a1fSBarry Smith 1718*bf388a1fSBarry Smith .seealso: SNESSetGS(), SNESGetGS() 1719*bf388a1fSBarry Smith M*/ 1720*bf388a1fSBarry Smith 1721534ebe21SPeter Brune #undef __FUNCT__ 1722646217ecSPeter Brune #define __FUNCT__ "SNESSetGS" 1723c79ef259SPeter Brune /*@C 1724c79ef259SPeter Brune SNESSetGS - Sets the user nonlinear Gauss-Seidel routine for 1725c79ef259SPeter Brune use with composed nonlinear solvers. 1726c79ef259SPeter Brune 1727c79ef259SPeter Brune Input Parameters: 1728c79ef259SPeter Brune + snes - the SNES context 1729*bf388a1fSBarry Smith . SNESGSFunction - function evaluation routine 1730c79ef259SPeter Brune - ctx - [optional] user-defined context for private data for the 1731c79ef259SPeter Brune smoother evaluation routine (may be PETSC_NULL) 1732c79ef259SPeter Brune 1733c79ef259SPeter Brune Notes: 1734c79ef259SPeter Brune The GS routines are used by the composed nonlinear solver to generate 1735c79ef259SPeter Brune a problem appropriate update to the solution, particularly FAS. 1736c79ef259SPeter Brune 1737d28543b3SPeter Brune Level: intermediate 1738c79ef259SPeter Brune 1739d28543b3SPeter Brune .keywords: SNES, nonlinear, set, Gauss-Seidel 1740c79ef259SPeter Brune 1741c79ef259SPeter Brune .seealso: SNESGetFunction(), SNESComputeGS() 1742c79ef259SPeter Brune @*/ 1743*bf388a1fSBarry Smith PetscErrorCode SNESSetGS(SNES snes,PetscErrorCode (*SNESGSFunction)(SNES,Vec,Vec,void*),void *ctx) 17446cab3a1bSJed Brown { 17456cab3a1bSJed Brown PetscErrorCode ierr; 17466cab3a1bSJed Brown DM dm; 17476cab3a1bSJed Brown 1748646217ecSPeter Brune PetscFunctionBegin; 17496cab3a1bSJed Brown PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 17506cab3a1bSJed Brown ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr); 1751*bf388a1fSBarry Smith ierr = DMSNESSetGS(dm,SNESGSFunction,ctx);CHKERRQ(ierr); 1752646217ecSPeter Brune PetscFunctionReturn(0); 1753646217ecSPeter Brune } 1754646217ecSPeter Brune 1755d25893d9SBarry Smith #undef __FUNCT__ 175689b92e6fSPeter Brune #define __FUNCT__ "SNESSetGSSweeps" 175789b92e6fSPeter Brune /*@ 175889b92e6fSPeter Brune SNESSetGSSweeps - Sets the number of sweeps of GS to use. 175989b92e6fSPeter Brune 176089b92e6fSPeter Brune Input Parameters: 176189b92e6fSPeter Brune + snes - the SNES context 176289b92e6fSPeter Brune - sweeps - the number of sweeps of GS to perform. 176389b92e6fSPeter Brune 176489b92e6fSPeter Brune Level: intermediate 176589b92e6fSPeter Brune 176689b92e6fSPeter Brune .keywords: SNES, nonlinear, set, Gauss-Siedel 176789b92e6fSPeter Brune 176889b92e6fSPeter Brune .seealso: SNESSetGS(), SNESGetGS(), SNESSetPC(), SNESGetGSSweeps() 176989b92e6fSPeter Brune @*/ 177089b92e6fSPeter Brune 1771c35f09e5SBarry Smith PetscErrorCode SNESSetGSSweeps(SNES snes, PetscInt sweeps) 1772c35f09e5SBarry Smith { 177389b92e6fSPeter Brune PetscFunctionBegin; 177489b92e6fSPeter Brune snes->gssweeps = sweeps; 177589b92e6fSPeter Brune PetscFunctionReturn(0); 177689b92e6fSPeter Brune } 177789b92e6fSPeter Brune 177889b92e6fSPeter Brune #undef __FUNCT__ 177989b92e6fSPeter Brune #define __FUNCT__ "SNESGetGSSweeps" 178089b92e6fSPeter Brune /*@ 178189b92e6fSPeter Brune SNESGetGSSweeps - Gets the number of sweeps GS will use. 178289b92e6fSPeter Brune 178389b92e6fSPeter Brune Input Parameters: 178489b92e6fSPeter Brune . snes - the SNES context 178589b92e6fSPeter Brune 178689b92e6fSPeter Brune Output Parameters: 178789b92e6fSPeter Brune . sweeps - the number of sweeps of GS to perform. 178889b92e6fSPeter Brune 178989b92e6fSPeter Brune Level: intermediate 179089b92e6fSPeter Brune 179189b92e6fSPeter Brune .keywords: SNES, nonlinear, set, Gauss-Siedel 179289b92e6fSPeter Brune 179389b92e6fSPeter Brune .seealso: SNESSetGS(), SNESGetGS(), SNESSetPC(), SNESSetGSSweeps() 179489b92e6fSPeter Brune @*/ 1795c35f09e5SBarry Smith PetscErrorCode SNESGetGSSweeps(SNES snes, PetscInt * sweeps) 1796c35f09e5SBarry Smith { 179789b92e6fSPeter Brune PetscFunctionBegin; 179889b92e6fSPeter Brune *sweeps = snes->gssweeps; 179989b92e6fSPeter Brune PetscFunctionReturn(0); 180089b92e6fSPeter Brune } 180189b92e6fSPeter Brune 180289b92e6fSPeter Brune #undef __FUNCT__ 18038b0a5094SBarry Smith #define __FUNCT__ "SNESPicardComputeFunction" 18048b0a5094SBarry Smith PetscErrorCode SNESPicardComputeFunction(SNES snes,Vec x,Vec f,void *ctx) 18058b0a5094SBarry Smith { 18068b0a5094SBarry Smith PetscErrorCode ierr; 1807e03ab78fSPeter Brune DM dm; 1808942e3340SBarry Smith DMSNES sdm; 18096cab3a1bSJed Brown 18108b0a5094SBarry Smith PetscFunctionBegin; 1811e03ab78fSPeter Brune ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr); 1812942e3340SBarry Smith ierr = DMGetDMSNES(dm,&sdm);CHKERRQ(ierr); 18138b0a5094SBarry Smith /* A(x)*x - b(x) */ 181422c6f798SBarry Smith if (sdm->ops->computepfunction) { 181522c6f798SBarry Smith ierr = (*sdm->ops->computepfunction)(snes,x,f,sdm->pctx);CHKERRQ(ierr); 181622c6f798SBarry Smith } else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE, "Must call SNESSetPicard() to provide Picard function."); 1817e03ab78fSPeter Brune 181822c6f798SBarry Smith if (sdm->ops->computepjacobian) { 181922c6f798SBarry Smith ierr = (*sdm->ops->computepjacobian)(snes,x,&snes->jacobian,&snes->jacobian_pre,&snes->matstruct,sdm->pctx);CHKERRQ(ierr); 182074e1e8c1SBarry Smith } else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE, "Must call SNESSetPicard() to provide Picard matrix."); 18218b0a5094SBarry Smith ierr = VecScale(f,-1.0);CHKERRQ(ierr); 182295eabcedSBarry Smith ierr = MatMultAdd(snes->jacobian,x,f,f);CHKERRQ(ierr); 18238b0a5094SBarry Smith PetscFunctionReturn(0); 18248b0a5094SBarry Smith } 18258b0a5094SBarry Smith 18268b0a5094SBarry Smith #undef __FUNCT__ 18278b0a5094SBarry Smith #define __FUNCT__ "SNESPicardComputeJacobian" 18288b0a5094SBarry Smith PetscErrorCode SNESPicardComputeJacobian(SNES snes,Vec x1,Mat *J,Mat *B,MatStructure *flag,void *ctx) 18298b0a5094SBarry Smith { 18308b0a5094SBarry Smith PetscFunctionBegin; 1831e03ab78fSPeter Brune /* the jacobian matrix should be pre-filled in SNESPicardComputeFunction */ 18328b0a5094SBarry Smith *flag = snes->matstruct; 18338b0a5094SBarry Smith PetscFunctionReturn(0); 18348b0a5094SBarry Smith } 18358b0a5094SBarry Smith 18368b0a5094SBarry Smith #undef __FUNCT__ 18378b0a5094SBarry Smith #define __FUNCT__ "SNESSetPicard" 18388b0a5094SBarry Smith /*@C 18390d04baf8SBarry Smith SNESSetPicard - Use SNES to solve the semilinear-system A(x) x = b(x) via a Picard type iteration (Picard linearization) 18408b0a5094SBarry Smith 18418b0a5094SBarry Smith Logically Collective on SNES 18428b0a5094SBarry Smith 18438b0a5094SBarry Smith Input Parameters: 18448b0a5094SBarry Smith + snes - the SNES context 18458b0a5094SBarry Smith . r - vector to store function value 1846*bf388a1fSBarry Smith . SNESFunction - function evaluation routine 1847f450aa47SBarry 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) 18488b0a5094SBarry Smith . mat - matrix to store A 1849*bf388a1fSBarry Smith . SNESJacobianFunction - function to compute matrix value 18508b0a5094SBarry Smith - ctx - [optional] user-defined context for private data for the 18518b0a5094SBarry Smith function evaluation routine (may be PETSC_NULL) 18528b0a5094SBarry Smith 18538b0a5094SBarry Smith Notes: 1854f450aa47SBarry 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 1855f450aa47SBarry 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. 1856f450aa47SBarry Smith 18578b0a5094SBarry Smith One can call SNESSetPicard() or SNESSetFunction() (and possibly SNESSetJacobian()) but cannot call both 18588b0a5094SBarry Smith 18598b0a5094SBarry 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} 18608b0a5094SBarry 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. 18618b0a5094SBarry Smith 18628b0a5094SBarry Smith Run with -snes_mf_operator to solve the system with Newton's method using A(x^{n}) to construct the preconditioner. 18638b0a5094SBarry Smith 18640d04baf8SBarry Smith We implement the defect correction form of the Picard iteration because it converges much more generally when inexact linear solvers are used then 18650d04baf8SBarry Smith the direct Picard iteration A(x^n) x^{n+1} = b(x^n) 18668b0a5094SBarry Smith 18678b0a5094SBarry 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 18688b0a5094SBarry 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 18698b0a5094SBarry Smith different please contact us at petsc-dev@mcs.anl.gov and we'll have an entirely new argument :-). 18708b0a5094SBarry Smith 1871f450aa47SBarry Smith Level: intermediate 18728b0a5094SBarry Smith 18738b0a5094SBarry Smith .keywords: SNES, nonlinear, set, function 18748b0a5094SBarry Smith 18750d04baf8SBarry Smith .seealso: SNESGetFunction(), SNESSetFunction(), SNESComputeFunction(), SNESSetJacobian(), SNESGetPicard(), SNESLineSearchPreCheckPicard() 18768b0a5094SBarry Smith @*/ 1877*bf388a1fSBarry 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) 18788b0a5094SBarry Smith { 18798b0a5094SBarry Smith PetscErrorCode ierr; 1880e03ab78fSPeter Brune DM dm; 1881e03ab78fSPeter Brune 18828b0a5094SBarry Smith PetscFunctionBegin; 18838b0a5094SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 1884e03ab78fSPeter Brune ierr = SNESGetDM(snes, &dm);CHKERRQ(ierr); 1885*bf388a1fSBarry Smith ierr = DMSNESSetPicard(dm,SNESFunction,SNESJacobianFunction,ctx);CHKERRQ(ierr); 18868b0a5094SBarry Smith ierr = SNESSetFunction(snes,r,SNESPicardComputeFunction,ctx);CHKERRQ(ierr); 18878b0a5094SBarry Smith ierr = SNESSetJacobian(snes,jmat,mat,SNESPicardComputeJacobian,ctx);CHKERRQ(ierr); 18888b0a5094SBarry Smith PetscFunctionReturn(0); 18898b0a5094SBarry Smith } 18908b0a5094SBarry Smith 18917971a8bfSPeter Brune #undef __FUNCT__ 18927971a8bfSPeter Brune #define __FUNCT__ "SNESGetPicard" 18937971a8bfSPeter Brune /*@C 18947971a8bfSPeter Brune SNESGetPicard - Returns the context for the Picard iteration 18957971a8bfSPeter Brune 18967971a8bfSPeter Brune Not Collective, but Vec is parallel if SNES is parallel. Collective if Vec is requested, but has not been created yet. 18977971a8bfSPeter Brune 18987971a8bfSPeter Brune Input Parameter: 18997971a8bfSPeter Brune . snes - the SNES context 19007971a8bfSPeter Brune 19017971a8bfSPeter Brune Output Parameter: 19027971a8bfSPeter Brune + r - the function (or PETSC_NULL) 1903*bf388a1fSBarry Smith . SNESFunction - the function (or PETSC_NULL) 19047971a8bfSPeter Brune . jmat - the picard matrix (or PETSC_NULL) 19057971a8bfSPeter Brune . mat - the picard preconditioner matrix (or PETSC_NULL) 1906*bf388a1fSBarry Smith . SNESJacobianFunction - the function for matrix evaluation (or PETSC_NULL) 19077971a8bfSPeter Brune - ctx - the function context (or PETSC_NULL) 19087971a8bfSPeter Brune 19097971a8bfSPeter Brune Level: advanced 19107971a8bfSPeter Brune 19117971a8bfSPeter Brune .keywords: SNES, nonlinear, get, function 19127971a8bfSPeter Brune 1913*bf388a1fSBarry Smith .seealso: SNESSetPicard, SNESGetFunction, SNESGetJacobian, SNESGetDM, SNESFunction, SNESJacobianFunction 19147971a8bfSPeter Brune @*/ 1915*bf388a1fSBarry 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) 19167971a8bfSPeter Brune { 19177971a8bfSPeter Brune PetscErrorCode ierr; 19187971a8bfSPeter Brune DM dm; 19197971a8bfSPeter Brune 19207971a8bfSPeter Brune PetscFunctionBegin; 19217971a8bfSPeter Brune PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 19227971a8bfSPeter Brune ierr = SNESGetFunction(snes,r,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr); 19237971a8bfSPeter Brune ierr = SNESGetJacobian(snes,jmat,mat,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr); 19247971a8bfSPeter Brune ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr); 1925*bf388a1fSBarry Smith ierr = DMSNESGetPicard(dm,SNESFunction,SNESJacobianFunction,ctx);CHKERRQ(ierr); 19267971a8bfSPeter Brune PetscFunctionReturn(0); 19277971a8bfSPeter Brune } 19287971a8bfSPeter Brune 19298b0a5094SBarry Smith #undef __FUNCT__ 1930d25893d9SBarry Smith #define __FUNCT__ "SNESSetComputeInitialGuess" 1931d25893d9SBarry Smith /*@C 1932d25893d9SBarry Smith SNESSetComputeInitialGuess - Sets a routine used to compute an initial guess for the problem 1933d25893d9SBarry Smith 1934d25893d9SBarry Smith Logically Collective on SNES 1935d25893d9SBarry Smith 1936d25893d9SBarry Smith Input Parameters: 1937d25893d9SBarry Smith + snes - the SNES context 1938d25893d9SBarry Smith . func - function evaluation routine 1939d25893d9SBarry Smith - ctx - [optional] user-defined context for private data for the 1940d25893d9SBarry Smith function evaluation routine (may be PETSC_NULL) 1941d25893d9SBarry Smith 1942d25893d9SBarry Smith Calling sequence of func: 1943d25893d9SBarry Smith $ func (SNES snes,Vec x,void *ctx); 1944d25893d9SBarry Smith 1945d25893d9SBarry Smith . f - function vector 1946d25893d9SBarry Smith - ctx - optional user-defined function context 1947d25893d9SBarry Smith 1948d25893d9SBarry Smith Level: intermediate 1949d25893d9SBarry Smith 1950d25893d9SBarry Smith .keywords: SNES, nonlinear, set, function 1951d25893d9SBarry Smith 1952d25893d9SBarry Smith .seealso: SNESGetFunction(), SNESComputeFunction(), SNESSetJacobian() 1953d25893d9SBarry Smith @*/ 1954d25893d9SBarry Smith PetscErrorCode SNESSetComputeInitialGuess(SNES snes,PetscErrorCode (*func)(SNES,Vec,void*),void *ctx) 1955d25893d9SBarry Smith { 1956d25893d9SBarry Smith PetscFunctionBegin; 1957d25893d9SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 1958d25893d9SBarry Smith if (func) snes->ops->computeinitialguess = func; 1959d25893d9SBarry Smith if (ctx) snes->initialguessP = ctx; 1960d25893d9SBarry Smith PetscFunctionReturn(0); 1961d25893d9SBarry Smith } 1962d25893d9SBarry Smith 19633ab0aad5SBarry Smith /* --------------------------------------------------------------- */ 19643ab0aad5SBarry Smith #undef __FUNCT__ 19651096aae1SMatthew Knepley #define __FUNCT__ "SNESGetRhs" 19661096aae1SMatthew Knepley /*@C 19671096aae1SMatthew Knepley SNESGetRhs - Gets the vector for solving F(x) = rhs. If rhs is not set 19681096aae1SMatthew Knepley it assumes a zero right hand side. 19691096aae1SMatthew Knepley 19703f9fe445SBarry Smith Logically Collective on SNES 19711096aae1SMatthew Knepley 19721096aae1SMatthew Knepley Input Parameter: 19731096aae1SMatthew Knepley . snes - the SNES context 19741096aae1SMatthew Knepley 19751096aae1SMatthew Knepley Output Parameter: 1976bc08b0f1SBarry Smith . rhs - the right hand side vector or PETSC_NULL if the right hand side vector is null 19771096aae1SMatthew Knepley 19781096aae1SMatthew Knepley Level: intermediate 19791096aae1SMatthew Knepley 19801096aae1SMatthew Knepley .keywords: SNES, nonlinear, get, function, right hand side 19811096aae1SMatthew Knepley 198285385478SLisandro Dalcin .seealso: SNESGetSolution(), SNESGetFunction(), SNESComputeFunction(), SNESSetJacobian(), SNESSetFunction() 19831096aae1SMatthew Knepley @*/ 19847087cfbeSBarry Smith PetscErrorCode SNESGetRhs(SNES snes,Vec *rhs) 19851096aae1SMatthew Knepley { 19861096aae1SMatthew Knepley PetscFunctionBegin; 19870700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 19881096aae1SMatthew Knepley PetscValidPointer(rhs,2); 198985385478SLisandro Dalcin *rhs = snes->vec_rhs; 19901096aae1SMatthew Knepley PetscFunctionReturn(0); 19911096aae1SMatthew Knepley } 19921096aae1SMatthew Knepley 19931096aae1SMatthew Knepley #undef __FUNCT__ 19944a2ae208SSatish Balay #define __FUNCT__ "SNESComputeFunction" 19959b94acceSBarry Smith /*@ 1996*bf388a1fSBarry Smith SNESComputeFunction - Calls the function that has been set with SNESSetFunction(). 19979b94acceSBarry Smith 1998c7afd0dbSLois Curfman McInnes Collective on SNES 1999c7afd0dbSLois Curfman McInnes 20009b94acceSBarry Smith Input Parameters: 2001c7afd0dbSLois Curfman McInnes + snes - the SNES context 2002c7afd0dbSLois Curfman McInnes - x - input vector 20039b94acceSBarry Smith 20049b94acceSBarry Smith Output Parameter: 20053638b69dSLois Curfman McInnes . y - function vector, as set by SNESSetFunction() 20069b94acceSBarry Smith 20071bffabb2SLois Curfman McInnes Notes: 200836851e7fSLois Curfman McInnes SNESComputeFunction() is typically used within nonlinear solvers 200936851e7fSLois Curfman McInnes implementations, so most users would not generally call this routine 201036851e7fSLois Curfman McInnes themselves. 201136851e7fSLois Curfman McInnes 201236851e7fSLois Curfman McInnes Level: developer 201336851e7fSLois Curfman McInnes 20149b94acceSBarry Smith .keywords: SNES, nonlinear, compute, function 20159b94acceSBarry Smith 2016a86d99e1SLois Curfman McInnes .seealso: SNESSetFunction(), SNESGetFunction() 20179b94acceSBarry Smith @*/ 20187087cfbeSBarry Smith PetscErrorCode SNESComputeFunction(SNES snes,Vec x,Vec y) 20199b94acceSBarry Smith { 2020dfbe8321SBarry Smith PetscErrorCode ierr; 20216cab3a1bSJed Brown DM dm; 2022942e3340SBarry Smith DMSNES sdm; 20239b94acceSBarry Smith 20243a40ed3dSBarry Smith PetscFunctionBegin; 20250700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 20260700a824SBarry Smith PetscValidHeaderSpecific(x,VEC_CLASSID,2); 20270700a824SBarry Smith PetscValidHeaderSpecific(y,VEC_CLASSID,3); 2028c9780b6fSBarry Smith PetscCheckSameComm(snes,1,x,2); 2029c9780b6fSBarry Smith PetscCheckSameComm(snes,1,y,3); 20304ec14c9cSBarry Smith VecValidValues(x,2,PETSC_TRUE); 2031184914b5SBarry Smith 20326cab3a1bSJed Brown ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr); 2033942e3340SBarry Smith ierr = DMGetDMSNES(dm,&sdm);CHKERRQ(ierr); 2034d5ba7fb7SMatthew Knepley ierr = PetscLogEventBegin(SNES_FunctionEval,snes,x,y,0);CHKERRQ(ierr); 2035c40d0f55SPeter Brune if (snes->pc && snes->pcside == PC_LEFT) { 2036c40d0f55SPeter Brune ierr = VecCopy(x,y);CHKERRQ(ierr); 2037c40d0f55SPeter Brune ierr = SNESSolve(snes->pc,snes->vec_rhs,y);CHKERRQ(ierr); 2038c40d0f55SPeter Brune ierr = VecAYPX(y,-1.0,x);CHKERRQ(ierr); 203922c6f798SBarry Smith } else if (sdm->ops->computefunction) { 2040d64ed03dSBarry Smith PetscStackPush("SNES user function"); 204122c6f798SBarry Smith ierr = (*sdm->ops->computefunction)(snes,x,y,sdm->functionctx);CHKERRQ(ierr); 2042d64ed03dSBarry Smith PetscStackPop; 2043c90fad12SPeter Brune } else if (snes->vec_rhs) { 2044c90fad12SPeter Brune ierr = MatMult(snes->jacobian, x, y);CHKERRQ(ierr); 2045644e2e5bSBarry Smith } else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE, "Must call SNESSetFunction() or SNESSetDM() before SNESComputeFunction(), likely called from SNESSolve()."); 204685385478SLisandro Dalcin if (snes->vec_rhs) { 204785385478SLisandro Dalcin ierr = VecAXPY(y,-1.0,snes->vec_rhs);CHKERRQ(ierr); 20483ab0aad5SBarry Smith } 2049ae3c334cSLois Curfman McInnes snes->nfuncs++; 2050d5ba7fb7SMatthew Knepley ierr = PetscLogEventEnd(SNES_FunctionEval,snes,x,y,0);CHKERRQ(ierr); 20514ec14c9cSBarry Smith VecValidValues(y,3,PETSC_FALSE); 20523a40ed3dSBarry Smith PetscFunctionReturn(0); 20539b94acceSBarry Smith } 20549b94acceSBarry Smith 20554a2ae208SSatish Balay #undef __FUNCT__ 2056646217ecSPeter Brune #define __FUNCT__ "SNESComputeGS" 2057c79ef259SPeter Brune /*@ 2058*bf388a1fSBarry Smith SNESComputeGS - Calls the Gauss-Seidel function that has been set with SNESSetGS(). 2059c79ef259SPeter Brune 2060c79ef259SPeter Brune Collective on SNES 2061c79ef259SPeter Brune 2062c79ef259SPeter Brune Input Parameters: 2063c79ef259SPeter Brune + snes - the SNES context 2064c79ef259SPeter Brune . x - input vector 2065c79ef259SPeter Brune - b - rhs vector 2066c79ef259SPeter Brune 2067c79ef259SPeter Brune Output Parameter: 2068c79ef259SPeter Brune . x - new solution vector 2069c79ef259SPeter Brune 2070c79ef259SPeter Brune Notes: 2071c79ef259SPeter Brune SNESComputeGS() is typically used within composed nonlinear solver 2072c79ef259SPeter Brune implementations, so most users would not generally call this routine 2073c79ef259SPeter Brune themselves. 2074c79ef259SPeter Brune 2075c79ef259SPeter Brune Level: developer 2076c79ef259SPeter Brune 2077c79ef259SPeter Brune .keywords: SNES, nonlinear, compute, function 2078c79ef259SPeter Brune 2079c79ef259SPeter Brune .seealso: SNESSetGS(), SNESComputeFunction() 2080c79ef259SPeter Brune @*/ 2081646217ecSPeter Brune PetscErrorCode SNESComputeGS(SNES snes,Vec b,Vec x) 2082646217ecSPeter Brune { 2083646217ecSPeter Brune PetscErrorCode ierr; 208489b92e6fSPeter Brune PetscInt i; 20856cab3a1bSJed Brown DM dm; 2086942e3340SBarry Smith DMSNES sdm; 2087646217ecSPeter Brune 2088646217ecSPeter Brune PetscFunctionBegin; 2089646217ecSPeter Brune PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 2090646217ecSPeter Brune PetscValidHeaderSpecific(x,VEC_CLASSID,2); 2091646217ecSPeter Brune if (b) PetscValidHeaderSpecific(b,VEC_CLASSID,3); 2092646217ecSPeter Brune PetscCheckSameComm(snes,1,x,2); 2093646217ecSPeter Brune if (b) PetscCheckSameComm(snes,1,b,3); 20944ec14c9cSBarry Smith if (b) VecValidValues(b,2,PETSC_TRUE); 2095701cf23dSPeter Brune ierr = PetscLogEventBegin(SNES_GSEval,snes,x,b,0);CHKERRQ(ierr); 20966cab3a1bSJed Brown ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr); 2097942e3340SBarry Smith ierr = DMGetDMSNES(dm,&sdm);CHKERRQ(ierr); 209822c6f798SBarry Smith if (sdm->ops->computegs) { 209989b92e6fSPeter Brune for (i = 0; i < snes->gssweeps; i++) { 2100646217ecSPeter Brune PetscStackPush("SNES user GS"); 210122c6f798SBarry Smith ierr = (*sdm->ops->computegs)(snes,x,b,sdm->gsctx);CHKERRQ(ierr); 2102646217ecSPeter Brune PetscStackPop; 210389b92e6fSPeter Brune } 2104646217ecSPeter Brune } else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE, "Must call SNESSetGS() before SNESComputeGS(), likely called from SNESSolve()."); 2105701cf23dSPeter Brune ierr = PetscLogEventEnd(SNES_GSEval,snes,x,b,0);CHKERRQ(ierr); 21064ec14c9cSBarry Smith VecValidValues(x,3,PETSC_FALSE); 2107646217ecSPeter Brune PetscFunctionReturn(0); 2108646217ecSPeter Brune } 2109646217ecSPeter Brune 2110646217ecSPeter Brune #undef __FUNCT__ 21114a2ae208SSatish Balay #define __FUNCT__ "SNESComputeJacobian" 211262fef451SLois Curfman McInnes /*@ 2113*bf388a1fSBarry Smith SNESComputeJacobian - Computes the Jacobian matrix that has been set with SNESSetJacobian(). 211462fef451SLois Curfman McInnes 2115c7afd0dbSLois Curfman McInnes Collective on SNES and Mat 2116c7afd0dbSLois Curfman McInnes 211762fef451SLois Curfman McInnes Input Parameters: 2118c7afd0dbSLois Curfman McInnes + snes - the SNES context 2119c7afd0dbSLois Curfman McInnes - x - input vector 212062fef451SLois Curfman McInnes 212162fef451SLois Curfman McInnes Output Parameters: 2122c7afd0dbSLois Curfman McInnes + A - Jacobian matrix 212362fef451SLois Curfman McInnes . B - optional preconditioning matrix 21242b668275SBarry Smith - flag - flag indicating matrix structure (one of, SAME_NONZERO_PATTERN,DIFFERENT_NONZERO_PATTERN,SAME_PRECONDITIONER) 2125fee21e36SBarry Smith 2126e35cf81dSBarry Smith Options Database Keys: 2127e35cf81dSBarry Smith + -snes_lag_preconditioner <lag> 2128693365a8SJed Brown . -snes_lag_jacobian <lag> 2129693365a8SJed Brown . -snes_compare_explicit - Compare the computed Jacobian to the finite difference Jacobian and output the differences 2130693365a8SJed Brown . -snes_compare_explicit_draw - Compare the computed Jacobian to the finite difference Jacobian and draw the result 2131693365a8SJed Brown . -snes_compare_explicit_contour - Compare the computed Jacobian to the finite difference Jacobian and draw a contour plot with the result 21324c30e9fbSJed Brown . -snes_compare_operator - Make the comparison options above use the operator instead of the preconditioning matrix 2133c01495d3SJed Brown . -snes_compare_coloring - Compute the finite differece Jacobian using coloring and display norms of difference 2134c01495d3SJed Brown . -snes_compare_coloring_display - Compute the finite differece Jacobian using coloring and display verbose differences 2135c01495d3SJed Brown . -snes_compare_coloring_threshold - Display only those matrix entries that differ by more than a given threshold 2136c01495d3SJed Brown . -snes_compare_coloring_threshold_atol - Absolute tolerance for difference in matrix entries to be displayed by -snes_compare_coloring_threshold 2137c01495d3SJed Brown . -snes_compare_coloring_threshold_rtol - Relative tolerance for difference in matrix entries to be displayed by -snes_compare_coloring_threshold 21384c30e9fbSJed Brown . -snes_compare_coloring_draw - Compute the finite differece Jacobian using coloring and draw differences 2139c01495d3SJed Brown - -snes_compare_coloring_draw_contour - Compute the finite differece Jacobian using coloring and show contours of matrices and differences 2140c01495d3SJed Brown 2141e35cf81dSBarry Smith 214262fef451SLois Curfman McInnes Notes: 214362fef451SLois Curfman McInnes Most users should not need to explicitly call this routine, as it 214462fef451SLois Curfman McInnes is used internally within the nonlinear solvers. 214562fef451SLois Curfman McInnes 214694b7f48cSBarry Smith See KSPSetOperators() for important information about setting the 2147dc5a77f8SLois Curfman McInnes flag parameter. 214862fef451SLois Curfman McInnes 214936851e7fSLois Curfman McInnes Level: developer 215036851e7fSLois Curfman McInnes 215162fef451SLois Curfman McInnes .keywords: SNES, compute, Jacobian, matrix 215262fef451SLois Curfman McInnes 2153e35cf81dSBarry Smith .seealso: SNESSetJacobian(), KSPSetOperators(), MatStructure, SNESSetLagPreconditioner(), SNESSetLagJacobian() 215462fef451SLois Curfman McInnes @*/ 21557087cfbeSBarry Smith PetscErrorCode SNESComputeJacobian(SNES snes,Vec X,Mat *A,Mat *B,MatStructure *flg) 21569b94acceSBarry Smith { 2157dfbe8321SBarry Smith PetscErrorCode ierr; 2158ace3abfcSBarry Smith PetscBool flag; 21596cab3a1bSJed Brown DM dm; 2160942e3340SBarry Smith DMSNES sdm; 21613a40ed3dSBarry Smith 21623a40ed3dSBarry Smith PetscFunctionBegin; 21630700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 21640700a824SBarry Smith PetscValidHeaderSpecific(X,VEC_CLASSID,2); 21654482741eSBarry Smith PetscValidPointer(flg,5); 2166c9780b6fSBarry Smith PetscCheckSameComm(snes,1,X,2); 21674ec14c9cSBarry Smith VecValidValues(X,2,PETSC_TRUE); 21686cab3a1bSJed Brown ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr); 2169942e3340SBarry Smith ierr = DMGetDMSNES(dm,&sdm);CHKERRQ(ierr); 21703232da50SPeter Brune 217122c6f798SBarry Smith if (!sdm->ops->computejacobian) SETERRQ(((PetscObject)snes)->comm,PETSC_ERR_USER,"Must call SNESSetJacobian(), DMSNESSetJacobian(), DMDASNESSetJacobianLocal(), etc"); 2172ebd3b9afSBarry Smith 2173ebd3b9afSBarry Smith /* make sure that MatAssemblyBegin/End() is called on A matrix if it is matrix free */ 2174ebd3b9afSBarry Smith 2175fe3ffe1eSBarry Smith if (snes->lagjacobian == -2) { 2176fe3ffe1eSBarry Smith snes->lagjacobian = -1; 2177fe3ffe1eSBarry Smith ierr = PetscInfo(snes,"Recomputing Jacobian/preconditioner because lag is -2 (means compute Jacobian, but then never again) \n");CHKERRQ(ierr); 2178fe3ffe1eSBarry Smith } else if (snes->lagjacobian == -1) { 2179e35cf81dSBarry Smith *flg = SAME_PRECONDITIONER; 2180e35cf81dSBarry Smith ierr = PetscInfo(snes,"Reusing Jacobian/preconditioner because lag is -1\n");CHKERRQ(ierr); 2181251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)*A,MATMFFD,&flag);CHKERRQ(ierr); 2182ebd3b9afSBarry Smith if (flag) { 2183ebd3b9afSBarry Smith ierr = MatAssemblyBegin(*A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 2184ebd3b9afSBarry Smith ierr = MatAssemblyEnd(*A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 2185ebd3b9afSBarry Smith } 2186e35cf81dSBarry Smith PetscFunctionReturn(0); 2187e35cf81dSBarry Smith } else if (snes->lagjacobian > 1 && snes->iter % snes->lagjacobian) { 2188e35cf81dSBarry Smith *flg = SAME_PRECONDITIONER; 2189e35cf81dSBarry Smith ierr = PetscInfo2(snes,"Reusing Jacobian/preconditioner because lag is %D and SNES iteration is %D\n",snes->lagjacobian,snes->iter);CHKERRQ(ierr); 2190251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)*A,MATMFFD,&flag);CHKERRQ(ierr); 2191ebd3b9afSBarry Smith if (flag) { 2192ebd3b9afSBarry Smith ierr = MatAssemblyBegin(*A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 2193ebd3b9afSBarry Smith ierr = MatAssemblyEnd(*A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 2194ebd3b9afSBarry Smith } 2195e35cf81dSBarry Smith PetscFunctionReturn(0); 2196e35cf81dSBarry Smith } 2197e35cf81dSBarry Smith 2198c4fc05e7SBarry Smith *flg = DIFFERENT_NONZERO_PATTERN; 2199e35cf81dSBarry Smith ierr = PetscLogEventBegin(SNES_JacobianEval,snes,X,*A,*B);CHKERRQ(ierr); 22003232da50SPeter Brune 2201d64ed03dSBarry Smith PetscStackPush("SNES user Jacobian function"); 220222c6f798SBarry Smith ierr = (*sdm->ops->computejacobian)(snes,X,A,B,flg,sdm->jacobianctx);CHKERRQ(ierr); 2203d64ed03dSBarry Smith PetscStackPop; 22043232da50SPeter Brune 2205d5ba7fb7SMatthew Knepley ierr = PetscLogEventEnd(SNES_JacobianEval,snes,X,*A,*B);CHKERRQ(ierr); 2206a8054027SBarry Smith 22073b4f5425SBarry Smith if (snes->lagpreconditioner == -2) { 22083b4f5425SBarry Smith ierr = PetscInfo(snes,"Rebuilding preconditioner exactly once since lag is -2\n");CHKERRQ(ierr); 22093b4f5425SBarry Smith snes->lagpreconditioner = -1; 22103b4f5425SBarry Smith } else if (snes->lagpreconditioner == -1) { 2211a8054027SBarry Smith *flg = SAME_PRECONDITIONER; 2212a8054027SBarry Smith ierr = PetscInfo(snes,"Reusing preconditioner because lag is -1\n");CHKERRQ(ierr); 2213a8054027SBarry Smith } else if (snes->lagpreconditioner > 1 && snes->iter % snes->lagpreconditioner) { 2214a8054027SBarry Smith *flg = SAME_PRECONDITIONER; 2215a8054027SBarry Smith ierr = PetscInfo2(snes,"Reusing preconditioner because lag is %D and SNES iteration is %D\n",snes->lagpreconditioner,snes->iter);CHKERRQ(ierr); 2216a8054027SBarry Smith } 2217a8054027SBarry Smith 22186d84be18SBarry Smith /* make sure user returned a correct Jacobian and preconditioner */ 22190700a824SBarry Smith /* PetscValidHeaderSpecific(*A,MAT_CLASSID,3); 22200700a824SBarry Smith PetscValidHeaderSpecific(*B,MAT_CLASSID,4); */ 2221693365a8SJed Brown { 2222693365a8SJed Brown PetscBool flag = PETSC_FALSE,flag_draw = PETSC_FALSE,flag_contour = PETSC_FALSE,flag_operator = PETSC_FALSE; 2223693365a8SJed Brown ierr = PetscOptionsGetBool(((PetscObject)snes)->prefix,"-snes_compare_explicit",&flag,PETSC_NULL);CHKERRQ(ierr); 2224693365a8SJed Brown ierr = PetscOptionsGetBool(((PetscObject)snes)->prefix,"-snes_compare_explicit_draw",&flag_draw,PETSC_NULL);CHKERRQ(ierr); 2225693365a8SJed Brown ierr = PetscOptionsGetBool(((PetscObject)snes)->prefix,"-snes_compare_explicit_draw_contour",&flag_contour,PETSC_NULL);CHKERRQ(ierr); 2226693365a8SJed Brown ierr = PetscOptionsGetBool(((PetscObject)snes)->prefix,"-snes_compare_operator",&flag_operator,PETSC_NULL);CHKERRQ(ierr); 2227693365a8SJed Brown if (flag || flag_draw || flag_contour) { 2228693365a8SJed Brown Mat Bexp_mine = PETSC_NULL,Bexp,FDexp; 2229693365a8SJed Brown MatStructure mstruct; 2230693365a8SJed Brown PetscViewer vdraw,vstdout; 22316b3a5b13SJed Brown PetscBool flg; 2232693365a8SJed Brown if (flag_operator) { 2233693365a8SJed Brown ierr = MatComputeExplicitOperator(*A,&Bexp_mine);CHKERRQ(ierr); 2234693365a8SJed Brown Bexp = Bexp_mine; 2235693365a8SJed Brown } else { 2236693365a8SJed Brown /* See if the preconditioning matrix can be viewed and added directly */ 2237251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompareAny((PetscObject)*B,&flg,MATSEQAIJ,MATMPIAIJ,MATSEQDENSE,MATMPIDENSE,MATSEQBAIJ,MATMPIBAIJ,MATSEQSBAIJ,MATMPIBAIJ,"");CHKERRQ(ierr); 2238693365a8SJed Brown if (flg) Bexp = *B; 2239693365a8SJed Brown else { 2240693365a8SJed Brown /* If the "preconditioning" matrix is itself MATSHELL or some other type without direct support */ 2241693365a8SJed Brown ierr = MatComputeExplicitOperator(*B,&Bexp_mine);CHKERRQ(ierr); 2242693365a8SJed Brown Bexp = Bexp_mine; 2243693365a8SJed Brown } 2244693365a8SJed Brown } 2245693365a8SJed Brown ierr = MatConvert(Bexp,MATSAME,MAT_INITIAL_MATRIX,&FDexp);CHKERRQ(ierr); 2246693365a8SJed Brown ierr = SNESDefaultComputeJacobian(snes,X,&FDexp,&FDexp,&mstruct,NULL);CHKERRQ(ierr); 2247693365a8SJed Brown ierr = PetscViewerASCIIGetStdout(((PetscObject)snes)->comm,&vstdout);CHKERRQ(ierr); 2248693365a8SJed Brown if (flag_draw || flag_contour) { 2249693365a8SJed Brown ierr = PetscViewerDrawOpen(((PetscObject)snes)->comm,0,"Explicit Jacobians",PETSC_DECIDE,PETSC_DECIDE,300,300,&vdraw);CHKERRQ(ierr); 2250693365a8SJed Brown if (flag_contour) {ierr = PetscViewerPushFormat(vdraw,PETSC_VIEWER_DRAW_CONTOUR);CHKERRQ(ierr);} 2251693365a8SJed Brown } else vdraw = PETSC_NULL; 2252693365a8SJed Brown ierr = PetscViewerASCIIPrintf(vstdout,"Explicit %s\n",flag_operator?"Jacobian":"preconditioning Jacobian");CHKERRQ(ierr); 2253693365a8SJed Brown if (flag) {ierr = MatView(Bexp,vstdout);CHKERRQ(ierr);} 2254693365a8SJed Brown if (vdraw) {ierr = MatView(Bexp,vdraw);CHKERRQ(ierr);} 2255693365a8SJed Brown ierr = PetscViewerASCIIPrintf(vstdout,"Finite difference Jacobian\n");CHKERRQ(ierr); 2256693365a8SJed Brown if (flag) {ierr = MatView(FDexp,vstdout);CHKERRQ(ierr);} 2257693365a8SJed Brown if (vdraw) {ierr = MatView(FDexp,vdraw);CHKERRQ(ierr);} 2258693365a8SJed Brown ierr = MatAYPX(FDexp,-1.0,Bexp,SAME_NONZERO_PATTERN);CHKERRQ(ierr); 2259693365a8SJed Brown ierr = PetscViewerASCIIPrintf(vstdout,"User-provided matrix minus finite difference Jacobian\n");CHKERRQ(ierr); 2260693365a8SJed Brown if (flag) {ierr = MatView(FDexp,vstdout);CHKERRQ(ierr);} 2261693365a8SJed Brown if (vdraw) { /* Always use contour for the difference */ 2262693365a8SJed Brown ierr = PetscViewerPushFormat(vdraw,PETSC_VIEWER_DRAW_CONTOUR);CHKERRQ(ierr); 2263693365a8SJed Brown ierr = MatView(FDexp,vdraw);CHKERRQ(ierr); 2264693365a8SJed Brown ierr = PetscViewerPopFormat(vdraw);CHKERRQ(ierr); 2265693365a8SJed Brown } 2266693365a8SJed Brown if (flag_contour) {ierr = PetscViewerPopFormat(vdraw);CHKERRQ(ierr);} 2267693365a8SJed Brown ierr = PetscViewerDestroy(&vdraw);CHKERRQ(ierr); 2268693365a8SJed Brown ierr = MatDestroy(&Bexp_mine);CHKERRQ(ierr); 2269693365a8SJed Brown ierr = MatDestroy(&FDexp);CHKERRQ(ierr); 2270693365a8SJed Brown } 2271693365a8SJed Brown } 22724c30e9fbSJed Brown { 22736719d8e4SJed Brown PetscBool flag = PETSC_FALSE,flag_display = PETSC_FALSE,flag_draw = PETSC_FALSE,flag_contour = PETSC_FALSE,flag_threshold = PETSC_FALSE; 22746719d8e4SJed Brown PetscReal threshold_atol = PETSC_SQRT_MACHINE_EPSILON,threshold_rtol = 10*PETSC_SQRT_MACHINE_EPSILON; 22754c30e9fbSJed Brown ierr = PetscOptionsGetBool(((PetscObject)snes)->prefix,"-snes_compare_coloring",&flag,PETSC_NULL);CHKERRQ(ierr); 22766719d8e4SJed Brown ierr = PetscOptionsGetBool(((PetscObject)snes)->prefix,"-snes_compare_coloring_display",&flag_display,PETSC_NULL);CHKERRQ(ierr); 22774c30e9fbSJed Brown ierr = PetscOptionsGetBool(((PetscObject)snes)->prefix,"-snes_compare_coloring_draw",&flag_draw,PETSC_NULL);CHKERRQ(ierr); 22784c30e9fbSJed Brown ierr = PetscOptionsGetBool(((PetscObject)snes)->prefix,"-snes_compare_coloring_draw_contour",&flag_contour,PETSC_NULL);CHKERRQ(ierr); 22796719d8e4SJed Brown ierr = PetscOptionsGetBool(((PetscObject)snes)->prefix,"-snes_compare_coloring_threshold",&flag_threshold,PETSC_NULL);CHKERRQ(ierr); 22806719d8e4SJed Brown ierr = PetscOptionsGetReal(((PetscObject)snes)->prefix,"-snes_compare_coloring_threshold_rtol",&threshold_rtol,PETSC_NULL);CHKERRQ(ierr); 22816719d8e4SJed Brown ierr = PetscOptionsGetReal(((PetscObject)snes)->prefix,"-snes_compare_coloring_threshold_atol",&threshold_atol,PETSC_NULL);CHKERRQ(ierr); 22826719d8e4SJed Brown if (flag || flag_display || flag_draw || flag_contour || flag_threshold) { 22834c30e9fbSJed Brown Mat Bfd; 22844c30e9fbSJed Brown MatStructure mstruct; 22854c30e9fbSJed Brown PetscViewer vdraw,vstdout; 22864c30e9fbSJed Brown ISColoring iscoloring; 22874c30e9fbSJed Brown MatFDColoring matfdcoloring; 22884c30e9fbSJed Brown PetscErrorCode (*func)(SNES,Vec,Vec,void*); 22894c30e9fbSJed Brown void *funcctx; 22906719d8e4SJed Brown PetscReal norm1,norm2,normmax; 22914c30e9fbSJed Brown 22924c30e9fbSJed Brown ierr = MatDuplicate(*B,MAT_DO_NOT_COPY_VALUES,&Bfd);CHKERRQ(ierr); 22934c30e9fbSJed Brown ierr = MatGetColoring(Bfd,MATCOLORINGSL,&iscoloring);CHKERRQ(ierr); 22944c30e9fbSJed Brown ierr = MatFDColoringCreate(Bfd,iscoloring,&matfdcoloring);CHKERRQ(ierr); 22954c30e9fbSJed Brown ierr = ISColoringDestroy(&iscoloring);CHKERRQ(ierr); 22964c30e9fbSJed Brown 22974c30e9fbSJed Brown /* This method of getting the function is currently unreliable since it doesn't work for DM local functions. */ 22984c30e9fbSJed Brown ierr = SNESGetFunction(snes,PETSC_NULL,&func,&funcctx);CHKERRQ(ierr); 22994c30e9fbSJed Brown ierr = MatFDColoringSetFunction(matfdcoloring,(PetscErrorCode(*)(void))func,funcctx);CHKERRQ(ierr); 23004c30e9fbSJed Brown ierr = PetscObjectSetOptionsPrefix((PetscObject)matfdcoloring,((PetscObject)snes)->prefix);CHKERRQ(ierr); 23014c30e9fbSJed Brown ierr = PetscObjectAppendOptionsPrefix((PetscObject)matfdcoloring,"coloring_");CHKERRQ(ierr); 23024c30e9fbSJed Brown ierr = MatFDColoringSetFromOptions(matfdcoloring);CHKERRQ(ierr); 23034c30e9fbSJed Brown ierr = MatFDColoringApply(Bfd,matfdcoloring,X,&mstruct,snes);CHKERRQ(ierr); 23044c30e9fbSJed Brown ierr = MatFDColoringDestroy(&matfdcoloring);CHKERRQ(ierr); 23054c30e9fbSJed Brown 23064c30e9fbSJed Brown ierr = PetscViewerASCIIGetStdout(((PetscObject)snes)->comm,&vstdout);CHKERRQ(ierr); 23074c30e9fbSJed Brown if (flag_draw || flag_contour) { 23084c30e9fbSJed Brown ierr = PetscViewerDrawOpen(((PetscObject)snes)->comm,0,"Colored Jacobians",PETSC_DECIDE,PETSC_DECIDE,300,300,&vdraw);CHKERRQ(ierr); 23094c30e9fbSJed Brown if (flag_contour) {ierr = PetscViewerPushFormat(vdraw,PETSC_VIEWER_DRAW_CONTOUR);CHKERRQ(ierr);} 23104c30e9fbSJed Brown } else vdraw = PETSC_NULL; 23114c30e9fbSJed Brown ierr = PetscViewerASCIIPrintf(vstdout,"Explicit preconditioning Jacobian\n");CHKERRQ(ierr); 23126719d8e4SJed Brown if (flag_display) {ierr = MatView(*B,vstdout);CHKERRQ(ierr);} 23134c30e9fbSJed Brown if (vdraw) {ierr = MatView(*B,vdraw);CHKERRQ(ierr);} 23144c30e9fbSJed Brown ierr = PetscViewerASCIIPrintf(vstdout,"Colored Finite difference Jacobian\n");CHKERRQ(ierr); 23156719d8e4SJed Brown if (flag_display) {ierr = MatView(Bfd,vstdout);CHKERRQ(ierr);} 23164c30e9fbSJed Brown if (vdraw) {ierr = MatView(Bfd,vdraw);CHKERRQ(ierr);} 23174c30e9fbSJed Brown ierr = MatAYPX(Bfd,-1.0,*B,SAME_NONZERO_PATTERN);CHKERRQ(ierr); 23184c30e9fbSJed Brown ierr = MatNorm(Bfd,NORM_1,&norm1);CHKERRQ(ierr); 23196719d8e4SJed Brown ierr = MatNorm(Bfd,NORM_FROBENIUS,&norm2);CHKERRQ(ierr); 23204c30e9fbSJed Brown ierr = MatNorm(Bfd,NORM_MAX,&normmax);CHKERRQ(ierr); 23216719d8e4SJed Brown ierr = PetscViewerASCIIPrintf(vstdout,"User-provided matrix minus finite difference Jacobian, norm1=%G normFrob=%G normmax=%G\n",norm1,norm2,normmax);CHKERRQ(ierr); 23226719d8e4SJed Brown if (flag_display) {ierr = MatView(Bfd,vstdout);CHKERRQ(ierr);} 23234c30e9fbSJed Brown if (vdraw) { /* Always use contour for the difference */ 23244c30e9fbSJed Brown ierr = PetscViewerPushFormat(vdraw,PETSC_VIEWER_DRAW_CONTOUR);CHKERRQ(ierr); 23254c30e9fbSJed Brown ierr = MatView(Bfd,vdraw);CHKERRQ(ierr); 23264c30e9fbSJed Brown ierr = PetscViewerPopFormat(vdraw);CHKERRQ(ierr); 23274c30e9fbSJed Brown } 23284c30e9fbSJed Brown if (flag_contour) {ierr = PetscViewerPopFormat(vdraw);CHKERRQ(ierr);} 23296719d8e4SJed Brown 23306719d8e4SJed Brown if (flag_threshold) { 23316719d8e4SJed Brown PetscInt bs,rstart,rend,i; 23326719d8e4SJed Brown ierr = MatGetBlockSize(*B,&bs);CHKERRQ(ierr); 23336719d8e4SJed Brown ierr = MatGetOwnershipRange(*B,&rstart,&rend);CHKERRQ(ierr); 23346719d8e4SJed Brown for (i=rstart; i<rend; i++) { 23356719d8e4SJed Brown const PetscScalar *ba,*ca; 23366719d8e4SJed Brown const PetscInt *bj,*cj; 23376719d8e4SJed Brown PetscInt bn,cn,j,maxentrycol = -1,maxdiffcol = -1,maxrdiffcol = -1; 23386719d8e4SJed Brown PetscReal maxentry = 0,maxdiff = 0,maxrdiff = 0; 23396719d8e4SJed Brown ierr = MatGetRow(*B,i,&bn,&bj,&ba);CHKERRQ(ierr); 23406719d8e4SJed Brown ierr = MatGetRow(Bfd,i,&cn,&cj,&ca);CHKERRQ(ierr); 23416719d8e4SJed Brown if (bn != cn) SETERRQ(((PetscObject)*A)->comm,PETSC_ERR_PLIB,"Unexpected different nonzero pattern in -snes_compare_coloring_threshold"); 23426719d8e4SJed Brown for (j=0; j<bn; j++) { 23436719d8e4SJed Brown PetscReal rdiff = PetscAbsScalar(ca[j]) / (threshold_atol + threshold_rtol*PetscAbsScalar(ba[j])); 23446719d8e4SJed Brown if (PetscAbsScalar(ba[j]) > PetscAbs(maxentry)) { 23456719d8e4SJed Brown maxentrycol = bj[j]; 23466719d8e4SJed Brown maxentry = PetscRealPart(ba[j]); 23476719d8e4SJed Brown } 23486719d8e4SJed Brown if (PetscAbsScalar(ca[j]) > PetscAbs(maxdiff)) { 23496719d8e4SJed Brown maxdiffcol = bj[j]; 23506719d8e4SJed Brown maxdiff = PetscRealPart(ca[j]); 23516719d8e4SJed Brown } 23526719d8e4SJed Brown if (rdiff > maxrdiff) { 23536719d8e4SJed Brown maxrdiffcol = bj[j]; 23546719d8e4SJed Brown maxrdiff = rdiff; 23556719d8e4SJed Brown } 23566719d8e4SJed Brown } 23576719d8e4SJed Brown if (maxrdiff > 1) { 23586719d8e4SJed 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); 23596719d8e4SJed Brown for (j=0; j<bn; j++) { 23606719d8e4SJed Brown PetscReal rdiff; 23616719d8e4SJed Brown rdiff = PetscAbsScalar(ca[j]) / (threshold_atol + threshold_rtol*PetscAbsScalar(ba[j])); 23626719d8e4SJed Brown if (rdiff > 1) { 23636719d8e4SJed Brown ierr = PetscViewerASCIIPrintf(vstdout," (%D,%G:%G)",bj[j],PetscRealPart(ba[j]),PetscRealPart(ca[j]));CHKERRQ(ierr); 23646719d8e4SJed Brown } 23656719d8e4SJed Brown } 23666719d8e4SJed Brown ierr = PetscViewerASCIIPrintf(vstdout,"\n",i,maxentry,maxdiff,maxrdiff);CHKERRQ(ierr); 23676719d8e4SJed Brown } 23686719d8e4SJed Brown ierr = MatRestoreRow(*B,i,&bn,&bj,&ba);CHKERRQ(ierr); 23696719d8e4SJed Brown ierr = MatRestoreRow(Bfd,i,&cn,&cj,&ca);CHKERRQ(ierr); 23706719d8e4SJed Brown } 23716719d8e4SJed Brown } 23724c30e9fbSJed Brown ierr = PetscViewerDestroy(&vdraw);CHKERRQ(ierr); 23734c30e9fbSJed Brown ierr = MatDestroy(&Bfd);CHKERRQ(ierr); 23744c30e9fbSJed Brown } 23754c30e9fbSJed Brown } 23763a40ed3dSBarry Smith PetscFunctionReturn(0); 23779b94acceSBarry Smith } 23789b94acceSBarry Smith 2379*bf388a1fSBarry Smith /*MC 2380*bf388a1fSBarry Smith SNESJacobianFunction - function used to convey the nonlinear Jacobian of the function to be solved by SNES 2381*bf388a1fSBarry Smith 2382*bf388a1fSBarry Smith Synopsis: 2383*bf388a1fSBarry Smith #include "petscsnes.h" 2384*bf388a1fSBarry Smith $ SNESJacobianFunction(SNES snes,Vec x,Mat *A,Mat *B,int *flag,void *ctx); 2385*bf388a1fSBarry Smith 2386*bf388a1fSBarry Smith + x - input vector 2387*bf388a1fSBarry Smith . A - Jacobian matrix 2388*bf388a1fSBarry Smith . B - preconditioner matrix, usually the same as A 2389*bf388a1fSBarry Smith . flag - flag indicating information about the preconditioner matrix 2390*bf388a1fSBarry Smith structure (same as flag in KSPSetOperators()), one of SAME_NONZERO_PATTERN,DIFFERENT_NONZERO_PATTERN,SAME_PRECONDITIONER 2391*bf388a1fSBarry Smith - ctx - [optional] user-defined Jacobian context 2392*bf388a1fSBarry Smith 2393*bf388a1fSBarry Smith .seealso: SNESSetFunction(), SNESGetFunction(), SNESSetJacobian(), SNESGetJacobian() 2394*bf388a1fSBarry Smith M*/ 2395*bf388a1fSBarry Smith 23964a2ae208SSatish Balay #undef __FUNCT__ 23974a2ae208SSatish Balay #define __FUNCT__ "SNESSetJacobian" 23989b94acceSBarry Smith /*@C 23999b94acceSBarry Smith SNESSetJacobian - Sets the function to compute Jacobian as well as the 2400044dda88SLois Curfman McInnes location to store the matrix. 24019b94acceSBarry Smith 24023f9fe445SBarry Smith Logically Collective on SNES and Mat 2403c7afd0dbSLois Curfman McInnes 24049b94acceSBarry Smith Input Parameters: 2405c7afd0dbSLois Curfman McInnes + snes - the SNES context 24069b94acceSBarry Smith . A - Jacobian matrix 24079b94acceSBarry Smith . B - preconditioner matrix (usually same as the Jacobian) 2408*bf388a1fSBarry Smith . SNESJacobianFunction - Jacobian evaluation routine (if PETSC_NULL then SNES retains any previously set value) 2409c7afd0dbSLois Curfman McInnes - ctx - [optional] user-defined context for private data for the 2410efd51863SBarry Smith Jacobian evaluation routine (may be PETSC_NULL) (if PETSC_NULL then SNES retains any previously set value) 24119b94acceSBarry Smith 24129b94acceSBarry Smith Notes: 241394b7f48cSBarry Smith See KSPSetOperators() for important information about setting the flag 24142cd2dfdcSLois Curfman McInnes output parameter in the routine func(). Be sure to read this information! 2415ac21db08SLois Curfman McInnes 2416ac21db08SLois Curfman McInnes The routine func() takes Mat * as the matrix arguments rather than Mat. 24179b94acceSBarry Smith This allows the Jacobian evaluation routine to replace A and/or B with a 24189b94acceSBarry Smith completely new new matrix structure (not just different matrix elements) 24199b94acceSBarry Smith when appropriate, for instance, if the nonzero structure is changing 24209b94acceSBarry Smith throughout the global iterations. 24219b94acceSBarry Smith 242216913363SBarry Smith If the A matrix and B matrix are different you must call MatAssemblyBegin/End() on 242316913363SBarry Smith each matrix. 242416913363SBarry Smith 2425a8a26c1eSJed Brown If using SNESDefaultComputeJacobianColor() to assemble a Jacobian, the ctx argument 2426a8a26c1eSJed Brown must be a MatFDColoring. 2427a8a26c1eSJed Brown 2428c3cc8fd1SJed Brown Other defect-correction schemes can be used by computing a different matrix in place of the Jacobian. One common 2429c3cc8fd1SJed Brown example is to use the "Picard linearization" which only differentiates through the highest order parts of each term. 2430c3cc8fd1SJed Brown 243136851e7fSLois Curfman McInnes Level: beginner 243236851e7fSLois Curfman McInnes 24339b94acceSBarry Smith .keywords: SNES, nonlinear, set, Jacobian, matrix 24349b94acceSBarry Smith 2435*bf388a1fSBarry Smith .seealso: KSPSetOperators(), SNESSetFunction(), MatMFFDComputeJacobian(), SNESDefaultComputeJacobianColor(), MatStructure, SNESJacobianFunction 24369b94acceSBarry Smith @*/ 2437*bf388a1fSBarry Smith PetscErrorCode SNESSetJacobian(SNES snes,Mat A,Mat B,PetscErrorCode (*SNESJacobianFunction)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void *ctx) 24389b94acceSBarry Smith { 2439dfbe8321SBarry Smith PetscErrorCode ierr; 24406cab3a1bSJed Brown DM dm; 24413a7fca6bSBarry Smith 24423a40ed3dSBarry Smith PetscFunctionBegin; 24430700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 24440700a824SBarry Smith if (A) PetscValidHeaderSpecific(A,MAT_CLASSID,2); 24450700a824SBarry Smith if (B) PetscValidHeaderSpecific(B,MAT_CLASSID,3); 2446c9780b6fSBarry Smith if (A) PetscCheckSameComm(snes,1,A,2); 244706975374SJed Brown if (B) PetscCheckSameComm(snes,1,B,3); 24486cab3a1bSJed Brown ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr); 2449*bf388a1fSBarry Smith ierr = DMSNESSetJacobian(dm,SNESJacobianFunction,ctx);CHKERRQ(ierr); 24503a7fca6bSBarry Smith if (A) { 24517dcf0eaaSdalcinl ierr = PetscObjectReference((PetscObject)A);CHKERRQ(ierr); 24526bf464f9SBarry Smith ierr = MatDestroy(&snes->jacobian);CHKERRQ(ierr); 24539b94acceSBarry Smith snes->jacobian = A; 24543a7fca6bSBarry Smith } 24553a7fca6bSBarry Smith if (B) { 24567dcf0eaaSdalcinl ierr = PetscObjectReference((PetscObject)B);CHKERRQ(ierr); 24576bf464f9SBarry Smith ierr = MatDestroy(&snes->jacobian_pre);CHKERRQ(ierr); 24589b94acceSBarry Smith snes->jacobian_pre = B; 24593a7fca6bSBarry Smith } 24603a40ed3dSBarry Smith PetscFunctionReturn(0); 24619b94acceSBarry Smith } 246262fef451SLois Curfman McInnes 24634a2ae208SSatish Balay #undef __FUNCT__ 24644a2ae208SSatish Balay #define __FUNCT__ "SNESGetJacobian" 2465c2aafc4cSSatish Balay /*@C 2466b4fd4287SBarry Smith SNESGetJacobian - Returns the Jacobian matrix and optionally the user 2467b4fd4287SBarry Smith provided context for evaluating the Jacobian. 2468b4fd4287SBarry Smith 2469c7afd0dbSLois Curfman McInnes Not Collective, but Mat object will be parallel if SNES object is 2470c7afd0dbSLois Curfman McInnes 2471b4fd4287SBarry Smith Input Parameter: 2472b4fd4287SBarry Smith . snes - the nonlinear solver context 2473b4fd4287SBarry Smith 2474b4fd4287SBarry Smith Output Parameters: 2475c7afd0dbSLois Curfman McInnes + A - location to stash Jacobian matrix (or PETSC_NULL) 2476b4fd4287SBarry Smith . B - location to stash preconditioner matrix (or PETSC_NULL) 2477*bf388a1fSBarry Smith . SNESJacobianFunction - location to put Jacobian function (or PETSC_NULL) 247870e92668SMatthew Knepley - ctx - location to stash Jacobian ctx (or PETSC_NULL) 2479fee21e36SBarry Smith 248036851e7fSLois Curfman McInnes Level: advanced 248136851e7fSLois Curfman McInnes 2482b4fd4287SBarry Smith .seealso: SNESSetJacobian(), SNESComputeJacobian() 2483b4fd4287SBarry Smith @*/ 2484*bf388a1fSBarry Smith PetscErrorCode SNESGetJacobian(SNES snes,Mat *A,Mat *B,PetscErrorCode (**SNESJacobianFunction)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void **ctx) 2485b4fd4287SBarry Smith { 24866cab3a1bSJed Brown PetscErrorCode ierr; 24876cab3a1bSJed Brown DM dm; 2488942e3340SBarry Smith DMSNES sdm; 24896cab3a1bSJed Brown 24903a40ed3dSBarry Smith PetscFunctionBegin; 24910700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 2492b4fd4287SBarry Smith if (A) *A = snes->jacobian; 2493b4fd4287SBarry Smith if (B) *B = snes->jacobian_pre; 24946cab3a1bSJed Brown ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr); 2495942e3340SBarry Smith ierr = DMGetDMSNES(dm,&sdm);CHKERRQ(ierr); 2496*bf388a1fSBarry Smith if (SNESJacobianFunction) *SNESJacobianFunction = sdm->ops->computejacobian; 24976cab3a1bSJed Brown if (ctx) *ctx = sdm->jacobianctx; 24983a40ed3dSBarry Smith PetscFunctionReturn(0); 2499b4fd4287SBarry Smith } 2500b4fd4287SBarry Smith 25014a2ae208SSatish Balay #undef __FUNCT__ 25024a2ae208SSatish Balay #define __FUNCT__ "SNESSetUp" 25039b94acceSBarry Smith /*@ 25049b94acceSBarry Smith SNESSetUp - Sets up the internal data structures for the later use 2505272ac6f2SLois Curfman McInnes of a nonlinear solver. 25069b94acceSBarry Smith 2507fee21e36SBarry Smith Collective on SNES 2508fee21e36SBarry Smith 2509c7afd0dbSLois Curfman McInnes Input Parameters: 251070e92668SMatthew Knepley . snes - the SNES context 2511c7afd0dbSLois Curfman McInnes 2512272ac6f2SLois Curfman McInnes Notes: 2513272ac6f2SLois Curfman McInnes For basic use of the SNES solvers the user need not explicitly call 2514272ac6f2SLois Curfman McInnes SNESSetUp(), since these actions will automatically occur during 2515272ac6f2SLois Curfman McInnes the call to SNESSolve(). However, if one wishes to control this 2516272ac6f2SLois Curfman McInnes phase separately, SNESSetUp() should be called after SNESCreate() 2517272ac6f2SLois Curfman McInnes and optional routines of the form SNESSetXXX(), but before SNESSolve(). 2518272ac6f2SLois Curfman McInnes 251936851e7fSLois Curfman McInnes Level: advanced 252036851e7fSLois Curfman McInnes 25219b94acceSBarry Smith .keywords: SNES, nonlinear, setup 25229b94acceSBarry Smith 25239b94acceSBarry Smith .seealso: SNESCreate(), SNESSolve(), SNESDestroy() 25249b94acceSBarry Smith @*/ 25257087cfbeSBarry Smith PetscErrorCode SNESSetUp(SNES snes) 25269b94acceSBarry Smith { 2527dfbe8321SBarry Smith PetscErrorCode ierr; 25286cab3a1bSJed Brown DM dm; 2529942e3340SBarry Smith DMSNES sdm; 2530c35f09e5SBarry Smith SNESLineSearch linesearch, pclinesearch; 25316e2a1849SPeter Brune void *lsprectx,*lspostctx; 25326e2a1849SPeter Brune SNESLineSearchPreCheckFunc lsprefunc; 25336e2a1849SPeter Brune SNESLineSearchPostCheckFunc lspostfunc; 25346e2a1849SPeter Brune PetscErrorCode (*func)(SNES,Vec,Vec,void*); 25356e2a1849SPeter Brune Vec f,fpc; 25366e2a1849SPeter Brune void *funcctx; 25376e2a1849SPeter Brune PetscErrorCode (*jac)(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 25381eb13d49SPeter Brune void *jacctx,*appctx; 25396e2a1849SPeter Brune Mat A,B; 25403a40ed3dSBarry Smith 25413a40ed3dSBarry Smith PetscFunctionBegin; 25420700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 25434dc4c822SBarry Smith if (snes->setupcalled) PetscFunctionReturn(0); 25449b94acceSBarry Smith 25457adad957SLisandro Dalcin if (!((PetscObject)snes)->type_name) { 254604d7464bSBarry Smith ierr = SNESSetType(snes,SNESNEWTONLS);CHKERRQ(ierr); 254785385478SLisandro Dalcin } 254885385478SLisandro Dalcin 2549a63bb30eSJed Brown ierr = SNESGetFunction(snes,&snes->vec_func,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr); 255017186662SBarry Smith if (snes->vec_func == snes->vec_sol) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_IDN,"Solution vector cannot be function vector"); 255158c9b817SLisandro Dalcin if (snes->vec_rhs == snes->vec_sol) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_IDN,"Solution vector cannot be right hand side vector"); 255258c9b817SLisandro Dalcin 255358c9b817SLisandro Dalcin if (!snes->vec_sol_update /* && snes->vec_sol */) { 255458c9b817SLisandro Dalcin ierr = VecDuplicate(snes->vec_sol,&snes->vec_sol_update);CHKERRQ(ierr); 255558c9b817SLisandro Dalcin ierr = PetscLogObjectParent(snes,snes->vec_sol_update);CHKERRQ(ierr); 255658c9b817SLisandro Dalcin } 255758c9b817SLisandro Dalcin 25586cab3a1bSJed Brown ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr); 2559d8f46077SPeter Brune ierr = DMShellSetGlobalVector(snes->dm,snes->vec_sol);CHKERRQ(ierr); 2560942e3340SBarry Smith ierr = DMGetDMSNES(dm,&sdm);CHKERRQ(ierr); 256122c6f798SBarry Smith if (!sdm->ops->computefunction) SETERRQ(((PetscObject)dm)->comm,PETSC_ERR_ARG_WRONGSTATE,"Function never provided to SNES object"); 256222c6f798SBarry Smith if (!sdm->ops->computejacobian) { 256319f7a02aSBarry Smith ierr = DMSNESSetJacobian(dm,SNESDefaultComputeJacobianColor,PETSC_NULL);CHKERRQ(ierr); 256419f7a02aSBarry Smith } 25656cab3a1bSJed Brown if (!snes->vec_func) { 25666cab3a1bSJed Brown ierr = DMCreateGlobalVector(dm,&snes->vec_func);CHKERRQ(ierr); 2567214df951SJed Brown } 2568efd51863SBarry Smith 256922d28d08SBarry Smith if (!snes->ksp) { 257022d28d08SBarry Smith ierr = SNESGetKSP(snes, &snes->ksp);CHKERRQ(ierr); 257122d28d08SBarry Smith } 2572b710008aSBarry Smith 257322d28d08SBarry Smith if (!snes->linesearch) { 257422d28d08SBarry Smith ierr = SNESGetSNESLineSearch(snes, &snes->linesearch);CHKERRQ(ierr); 257522d28d08SBarry Smith } 25769e764e56SPeter Brune 2577172a4300SPeter Brune if (snes->pc && (snes->pcside == PC_LEFT)) { 2578172a4300SPeter Brune snes->mf = PETSC_TRUE; 2579172a4300SPeter Brune snes->mf_operator = PETSC_FALSE; 2580172a4300SPeter Brune } 2581d8f46077SPeter Brune 258228a52e04SBarry Smith if (snes->mf) { 258328a52e04SBarry Smith ierr = SNESSetUpMatrixFree_Private(snes, snes->mf_operator, snes->mf_version);CHKERRQ(ierr); 258428a52e04SBarry Smith } 2585d8f46077SPeter Brune 2586d25893d9SBarry Smith if (snes->ops->usercompute && !snes->user) { 2587d25893d9SBarry Smith ierr = (*snes->ops->usercompute)(snes,(void**)&snes->user);CHKERRQ(ierr); 2588d25893d9SBarry Smith } 2589d25893d9SBarry Smith 25906e2a1849SPeter Brune if (snes->pc) { 25916e2a1849SPeter Brune /* copy the DM over */ 25926e2a1849SPeter Brune ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr); 25936e2a1849SPeter Brune ierr = SNESSetDM(snes->pc,dm);CHKERRQ(ierr); 25946e2a1849SPeter Brune 25956e2a1849SPeter Brune ierr = SNESGetFunction(snes,&f,&func,&funcctx);CHKERRQ(ierr); 25966e2a1849SPeter Brune ierr = VecDuplicate(f,&fpc);CHKERRQ(ierr); 25976e2a1849SPeter Brune ierr = SNESSetFunction(snes->pc,fpc,func,funcctx);CHKERRQ(ierr); 25986e2a1849SPeter Brune ierr = SNESGetJacobian(snes,&A,&B,&jac,&jacctx);CHKERRQ(ierr); 25996e2a1849SPeter Brune ierr = SNESSetJacobian(snes->pc,A,B,jac,jacctx);CHKERRQ(ierr); 26001eb13d49SPeter Brune ierr = SNESGetApplicationContext(snes,&appctx);CHKERRQ(ierr); 26011eb13d49SPeter Brune ierr = SNESSetApplicationContext(snes->pc,appctx);CHKERRQ(ierr); 26026e2a1849SPeter Brune ierr = VecDestroy(&fpc);CHKERRQ(ierr); 26036e2a1849SPeter Brune 26046e2a1849SPeter Brune /* copy the function pointers over */ 26056e2a1849SPeter Brune ierr = PetscObjectCopyFortranFunctionPointers((PetscObject)snes,(PetscObject)snes->pc);CHKERRQ(ierr); 26066e2a1849SPeter Brune 26076e2a1849SPeter Brune /* default to 1 iteration */ 2608140836e4SPeter Brune ierr = SNESSetTolerances(snes->pc, 0.0, 0.0, 0.0, 1, snes->pc->max_funcs);CHKERRQ(ierr); 26096e2a1849SPeter Brune ierr = SNESSetNormType(snes->pc, SNES_NORM_FINAL_ONLY);CHKERRQ(ierr); 26106e2a1849SPeter Brune ierr = SNESSetFromOptions(snes->pc);CHKERRQ(ierr); 26116e2a1849SPeter Brune 26126e2a1849SPeter Brune /* copy the line search context over */ 26136e2a1849SPeter Brune ierr = SNESGetSNESLineSearch(snes,&linesearch);CHKERRQ(ierr); 26146e2a1849SPeter Brune ierr = SNESGetSNESLineSearch(snes->pc,&pclinesearch);CHKERRQ(ierr); 26156e2a1849SPeter Brune ierr = SNESLineSearchGetPreCheck(linesearch,&lsprefunc,&lsprectx);CHKERRQ(ierr); 26166e2a1849SPeter Brune ierr = SNESLineSearchGetPostCheck(linesearch,&lspostfunc,&lspostctx);CHKERRQ(ierr); 26176e2a1849SPeter Brune ierr = SNESLineSearchSetPreCheck(pclinesearch,lsprefunc,lsprectx);CHKERRQ(ierr); 26186e2a1849SPeter Brune ierr = SNESLineSearchSetPostCheck(pclinesearch,lspostfunc,lspostctx);CHKERRQ(ierr); 26196e2a1849SPeter Brune ierr = PetscObjectCopyFortranFunctionPointers((PetscObject)linesearch, (PetscObject)pclinesearch);CHKERRQ(ierr); 26206e2a1849SPeter Brune } 26216e2a1849SPeter Brune 2622410397dcSLisandro Dalcin if (snes->ops->setup) { 2623410397dcSLisandro Dalcin ierr = (*snes->ops->setup)(snes);CHKERRQ(ierr); 2624410397dcSLisandro Dalcin } 262558c9b817SLisandro Dalcin 26267aaed0d8SBarry Smith snes->setupcalled = PETSC_TRUE; 26273a40ed3dSBarry Smith PetscFunctionReturn(0); 26289b94acceSBarry Smith } 26299b94acceSBarry Smith 26304a2ae208SSatish Balay #undef __FUNCT__ 263137596af1SLisandro Dalcin #define __FUNCT__ "SNESReset" 263237596af1SLisandro Dalcin /*@ 263337596af1SLisandro Dalcin SNESReset - Resets a SNES context to the snessetupcalled = 0 state and removes any allocated Vecs and Mats 263437596af1SLisandro Dalcin 263537596af1SLisandro Dalcin Collective on SNES 263637596af1SLisandro Dalcin 263737596af1SLisandro Dalcin Input Parameter: 263837596af1SLisandro Dalcin . snes - iterative context obtained from SNESCreate() 263937596af1SLisandro Dalcin 2640d25893d9SBarry Smith Level: intermediate 2641d25893d9SBarry Smith 2642d25893d9SBarry Smith Notes: Also calls the application context destroy routine set with SNESSetComputeApplicationContext() 264337596af1SLisandro Dalcin 264437596af1SLisandro Dalcin .keywords: SNES, destroy 264537596af1SLisandro Dalcin 264637596af1SLisandro Dalcin .seealso: SNESCreate(), SNESSetUp(), SNESSolve() 264737596af1SLisandro Dalcin @*/ 264837596af1SLisandro Dalcin PetscErrorCode SNESReset(SNES snes) 264937596af1SLisandro Dalcin { 265037596af1SLisandro Dalcin PetscErrorCode ierr; 265137596af1SLisandro Dalcin 265237596af1SLisandro Dalcin PetscFunctionBegin; 265337596af1SLisandro Dalcin PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 2654d25893d9SBarry Smith if (snes->ops->userdestroy && snes->user) { 2655d25893d9SBarry Smith ierr = (*snes->ops->userdestroy)((void**)&snes->user);CHKERRQ(ierr); 2656d25893d9SBarry Smith snes->user = PETSC_NULL; 2657d25893d9SBarry Smith } 26588a23116dSBarry Smith if (snes->pc) { 26598a23116dSBarry Smith ierr = SNESReset(snes->pc);CHKERRQ(ierr); 26608a23116dSBarry Smith } 26618a23116dSBarry Smith 266237596af1SLisandro Dalcin if (snes->ops->reset) { 266337596af1SLisandro Dalcin ierr = (*snes->ops->reset)(snes);CHKERRQ(ierr); 266437596af1SLisandro Dalcin } 26659e764e56SPeter Brune if (snes->ksp) { 26669e764e56SPeter Brune ierr = KSPReset(snes->ksp);CHKERRQ(ierr); 26679e764e56SPeter Brune } 26689e764e56SPeter Brune 26699e764e56SPeter Brune if (snes->linesearch) { 2670f1c6b773SPeter Brune ierr = SNESLineSearchReset(snes->linesearch);CHKERRQ(ierr); 26719e764e56SPeter Brune } 26729e764e56SPeter Brune 26736bf464f9SBarry Smith ierr = VecDestroy(&snes->vec_rhs);CHKERRQ(ierr); 26746bf464f9SBarry Smith ierr = VecDestroy(&snes->vec_sol);CHKERRQ(ierr); 26756bf464f9SBarry Smith ierr = VecDestroy(&snes->vec_sol_update);CHKERRQ(ierr); 26766bf464f9SBarry Smith ierr = VecDestroy(&snes->vec_func);CHKERRQ(ierr); 26776bf464f9SBarry Smith ierr = MatDestroy(&snes->jacobian);CHKERRQ(ierr); 26786bf464f9SBarry Smith ierr = MatDestroy(&snes->jacobian_pre);CHKERRQ(ierr); 2679c41d97abSJed Brown ierr = VecDestroyVecs(snes->nwork,&snes->work);CHKERRQ(ierr); 2680c41d97abSJed Brown ierr = VecDestroyVecs(snes->nvwork,&snes->vwork);CHKERRQ(ierr); 268137596af1SLisandro Dalcin snes->nwork = snes->nvwork = 0; 268237596af1SLisandro Dalcin snes->setupcalled = PETSC_FALSE; 268337596af1SLisandro Dalcin PetscFunctionReturn(0); 268437596af1SLisandro Dalcin } 268537596af1SLisandro Dalcin 268637596af1SLisandro Dalcin #undef __FUNCT__ 26874a2ae208SSatish Balay #define __FUNCT__ "SNESDestroy" 268852baeb72SSatish Balay /*@ 26899b94acceSBarry Smith SNESDestroy - Destroys the nonlinear solver context that was created 26909b94acceSBarry Smith with SNESCreate(). 26919b94acceSBarry Smith 2692c7afd0dbSLois Curfman McInnes Collective on SNES 2693c7afd0dbSLois Curfman McInnes 26949b94acceSBarry Smith Input Parameter: 26959b94acceSBarry Smith . snes - the SNES context 26969b94acceSBarry Smith 269736851e7fSLois Curfman McInnes Level: beginner 269836851e7fSLois Curfman McInnes 26999b94acceSBarry Smith .keywords: SNES, nonlinear, destroy 27009b94acceSBarry Smith 270163a78c88SLois Curfman McInnes .seealso: SNESCreate(), SNESSolve() 27029b94acceSBarry Smith @*/ 27036bf464f9SBarry Smith PetscErrorCode SNESDestroy(SNES *snes) 27049b94acceSBarry Smith { 27056849ba73SBarry Smith PetscErrorCode ierr; 27063a40ed3dSBarry Smith 27073a40ed3dSBarry Smith PetscFunctionBegin; 27086bf464f9SBarry Smith if (!*snes) PetscFunctionReturn(0); 27096bf464f9SBarry Smith PetscValidHeaderSpecific((*snes),SNES_CLASSID,1); 27106bf464f9SBarry Smith if (--((PetscObject)(*snes))->refct > 0) {*snes = 0; PetscFunctionReturn(0);} 2711d4bb536fSBarry Smith 27126bf464f9SBarry Smith ierr = SNESReset((*snes));CHKERRQ(ierr); 27138a23116dSBarry Smith ierr = SNESDestroy(&(*snes)->pc);CHKERRQ(ierr); 27146b8b9a38SLisandro Dalcin 2715be0abb6dSBarry Smith /* if memory was published with AMS then destroy it */ 27166bf464f9SBarry Smith ierr = PetscObjectDepublish((*snes));CHKERRQ(ierr); 27176bf464f9SBarry Smith if ((*snes)->ops->destroy) {ierr = (*((*snes))->ops->destroy)((*snes));CHKERRQ(ierr);} 27186d4c513bSLisandro Dalcin 27196bf464f9SBarry Smith ierr = DMDestroy(&(*snes)->dm);CHKERRQ(ierr); 27206bf464f9SBarry Smith ierr = KSPDestroy(&(*snes)->ksp);CHKERRQ(ierr); 2721f1c6b773SPeter Brune ierr = SNESLineSearchDestroy(&(*snes)->linesearch);CHKERRQ(ierr); 27226b8b9a38SLisandro Dalcin 27236bf464f9SBarry Smith ierr = PetscFree((*snes)->kspconvctx);CHKERRQ(ierr); 27246bf464f9SBarry Smith if ((*snes)->ops->convergeddestroy) { 27256bf464f9SBarry Smith ierr = (*(*snes)->ops->convergeddestroy)((*snes)->cnvP);CHKERRQ(ierr); 27266b8b9a38SLisandro Dalcin } 27276bf464f9SBarry Smith if ((*snes)->conv_malloc) { 27286bf464f9SBarry Smith ierr = PetscFree((*snes)->conv_hist);CHKERRQ(ierr); 27296bf464f9SBarry Smith ierr = PetscFree((*snes)->conv_hist_its);CHKERRQ(ierr); 273058c9b817SLisandro Dalcin } 27316bf464f9SBarry Smith ierr = SNESMonitorCancel((*snes));CHKERRQ(ierr); 2732a79aaaedSSatish Balay ierr = PetscHeaderDestroy(snes);CHKERRQ(ierr); 27333a40ed3dSBarry Smith PetscFunctionReturn(0); 27349b94acceSBarry Smith } 27359b94acceSBarry Smith 27369b94acceSBarry Smith /* ----------- Routines to set solver parameters ---------- */ 27379b94acceSBarry Smith 27384a2ae208SSatish Balay #undef __FUNCT__ 2739a8054027SBarry Smith #define __FUNCT__ "SNESSetLagPreconditioner" 2740a8054027SBarry Smith /*@ 2741a8054027SBarry Smith SNESSetLagPreconditioner - Determines when the preconditioner is rebuilt in the nonlinear solve. 2742a8054027SBarry Smith 27433f9fe445SBarry Smith Logically Collective on SNES 2744a8054027SBarry Smith 2745a8054027SBarry Smith Input Parameters: 2746a8054027SBarry Smith + snes - the SNES context 2747a8054027SBarry 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 27483b4f5425SBarry Smith the Jacobian is built etc. -2 indicates rebuild preconditioner at next chance but then never rebuild after that 2749a8054027SBarry Smith 2750a8054027SBarry Smith Options Database Keys: 2751a8054027SBarry Smith . -snes_lag_preconditioner <lag> 2752a8054027SBarry Smith 2753a8054027SBarry Smith Notes: 2754a8054027SBarry Smith The default is 1 2755a8054027SBarry Smith The preconditioner is ALWAYS built in the first iteration of a nonlinear solve unless lag is -1 2756a8054027SBarry Smith If -1 is used before the very first nonlinear solve the preconditioner is still built because there is no previous preconditioner to use 2757a8054027SBarry Smith 2758a8054027SBarry Smith Level: intermediate 2759a8054027SBarry Smith 2760a8054027SBarry Smith .keywords: SNES, nonlinear, set, convergence, tolerances 2761a8054027SBarry Smith 2762e35cf81dSBarry Smith .seealso: SNESSetTrustRegionTolerance(), SNESGetLagPreconditioner(), SNESSetLagJacobian(), SNESGetLagJacobian() 2763a8054027SBarry Smith 2764a8054027SBarry Smith @*/ 27657087cfbeSBarry Smith PetscErrorCode SNESSetLagPreconditioner(SNES snes,PetscInt lag) 2766a8054027SBarry Smith { 2767a8054027SBarry Smith PetscFunctionBegin; 27680700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 2769e32f2f54SBarry Smith if (lag < -2) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Lag must be -2, -1, 1 or greater"); 2770e32f2f54SBarry Smith if (!lag) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Lag cannot be 0"); 2771c5eb9154SBarry Smith PetscValidLogicalCollectiveInt(snes,lag,2); 2772a8054027SBarry Smith snes->lagpreconditioner = lag; 2773a8054027SBarry Smith PetscFunctionReturn(0); 2774a8054027SBarry Smith } 2775a8054027SBarry Smith 2776a8054027SBarry Smith #undef __FUNCT__ 2777efd51863SBarry Smith #define __FUNCT__ "SNESSetGridSequence" 2778efd51863SBarry Smith /*@ 2779efd51863SBarry Smith SNESSetGridSequence - sets the number of steps of grid sequencing that SNES does 2780efd51863SBarry Smith 2781efd51863SBarry Smith Logically Collective on SNES 2782efd51863SBarry Smith 2783efd51863SBarry Smith Input Parameters: 2784efd51863SBarry Smith + snes - the SNES context 2785efd51863SBarry Smith - steps - the number of refinements to do, defaults to 0 2786efd51863SBarry Smith 2787efd51863SBarry Smith Options Database Keys: 2788efd51863SBarry Smith . -snes_grid_sequence <steps> 2789efd51863SBarry Smith 2790efd51863SBarry Smith Level: intermediate 2791efd51863SBarry Smith 2792c0df2a02SJed Brown Notes: 2793c0df2a02SJed Brown Use SNESGetSolution() to extract the fine grid solution after grid sequencing. 2794c0df2a02SJed Brown 2795efd51863SBarry Smith .keywords: SNES, nonlinear, set, convergence, tolerances 2796efd51863SBarry Smith 2797efd51863SBarry Smith .seealso: SNESSetTrustRegionTolerance(), SNESGetLagPreconditioner(), SNESSetLagJacobian(), SNESGetLagJacobian() 2798efd51863SBarry Smith 2799efd51863SBarry Smith @*/ 2800efd51863SBarry Smith PetscErrorCode SNESSetGridSequence(SNES snes,PetscInt steps) 2801efd51863SBarry Smith { 2802efd51863SBarry Smith PetscFunctionBegin; 2803efd51863SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 2804efd51863SBarry Smith PetscValidLogicalCollectiveInt(snes,steps,2); 2805efd51863SBarry Smith snes->gridsequence = steps; 2806efd51863SBarry Smith PetscFunctionReturn(0); 2807efd51863SBarry Smith } 2808efd51863SBarry Smith 2809efd51863SBarry Smith #undef __FUNCT__ 2810a8054027SBarry Smith #define __FUNCT__ "SNESGetLagPreconditioner" 2811a8054027SBarry Smith /*@ 2812a8054027SBarry Smith SNESGetLagPreconditioner - Indicates how often the preconditioner is rebuilt 2813a8054027SBarry Smith 28143f9fe445SBarry Smith Not Collective 2815a8054027SBarry Smith 2816a8054027SBarry Smith Input Parameter: 2817a8054027SBarry Smith . snes - the SNES context 2818a8054027SBarry Smith 2819a8054027SBarry Smith Output Parameter: 2820a8054027SBarry 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 28213b4f5425SBarry Smith the Jacobian is built etc. -2 indicates rebuild preconditioner at next chance but then never rebuild after that 2822a8054027SBarry Smith 2823a8054027SBarry Smith Options Database Keys: 2824a8054027SBarry Smith . -snes_lag_preconditioner <lag> 2825a8054027SBarry Smith 2826a8054027SBarry Smith Notes: 2827a8054027SBarry Smith The default is 1 2828a8054027SBarry Smith The preconditioner is ALWAYS built in the first iteration of a nonlinear solve unless lag is -1 2829a8054027SBarry Smith 2830a8054027SBarry Smith Level: intermediate 2831a8054027SBarry Smith 2832a8054027SBarry Smith .keywords: SNES, nonlinear, set, convergence, tolerances 2833a8054027SBarry Smith 2834a8054027SBarry Smith .seealso: SNESSetTrustRegionTolerance(), SNESSetLagPreconditioner() 2835a8054027SBarry Smith 2836a8054027SBarry Smith @*/ 28377087cfbeSBarry Smith PetscErrorCode SNESGetLagPreconditioner(SNES snes,PetscInt *lag) 2838a8054027SBarry Smith { 2839a8054027SBarry Smith PetscFunctionBegin; 28400700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 2841a8054027SBarry Smith *lag = snes->lagpreconditioner; 2842a8054027SBarry Smith PetscFunctionReturn(0); 2843a8054027SBarry Smith } 2844a8054027SBarry Smith 2845a8054027SBarry Smith #undef __FUNCT__ 2846e35cf81dSBarry Smith #define __FUNCT__ "SNESSetLagJacobian" 2847e35cf81dSBarry Smith /*@ 2848e35cf81dSBarry Smith SNESSetLagJacobian - Determines when the Jacobian is rebuilt in the nonlinear solve. See SNESSetLagPreconditioner() for determining how 2849e35cf81dSBarry Smith often the preconditioner is rebuilt. 2850e35cf81dSBarry Smith 28513f9fe445SBarry Smith Logically Collective on SNES 2852e35cf81dSBarry Smith 2853e35cf81dSBarry Smith Input Parameters: 2854e35cf81dSBarry Smith + snes - the SNES context 2855e35cf81dSBarry 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 2856fe3ffe1eSBarry Smith the Jacobian is built etc. -2 means rebuild at next chance but then never again 2857e35cf81dSBarry Smith 2858e35cf81dSBarry Smith Options Database Keys: 2859e35cf81dSBarry Smith . -snes_lag_jacobian <lag> 2860e35cf81dSBarry Smith 2861e35cf81dSBarry Smith Notes: 2862e35cf81dSBarry Smith The default is 1 2863e35cf81dSBarry Smith The Jacobian is ALWAYS built in the first iteration of a nonlinear solve unless lag is -1 2864fe3ffe1eSBarry 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 2865fe3ffe1eSBarry Smith at the next Newton step but never again (unless it is reset to another value) 2866e35cf81dSBarry Smith 2867e35cf81dSBarry Smith Level: intermediate 2868e35cf81dSBarry Smith 2869e35cf81dSBarry Smith .keywords: SNES, nonlinear, set, convergence, tolerances 2870e35cf81dSBarry Smith 2871e35cf81dSBarry Smith .seealso: SNESSetTrustRegionTolerance(), SNESGetLagPreconditioner(), SNESSetLagPreconditioner(), SNESGetLagJacobian() 2872e35cf81dSBarry Smith 2873e35cf81dSBarry Smith @*/ 28747087cfbeSBarry Smith PetscErrorCode SNESSetLagJacobian(SNES snes,PetscInt lag) 2875e35cf81dSBarry Smith { 2876e35cf81dSBarry Smith PetscFunctionBegin; 28770700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 2878e32f2f54SBarry Smith if (lag < -2) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Lag must be -2, -1, 1 or greater"); 2879e32f2f54SBarry Smith if (!lag) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Lag cannot be 0"); 2880c5eb9154SBarry Smith PetscValidLogicalCollectiveInt(snes,lag,2); 2881e35cf81dSBarry Smith snes->lagjacobian = lag; 2882e35cf81dSBarry Smith PetscFunctionReturn(0); 2883e35cf81dSBarry Smith } 2884e35cf81dSBarry Smith 2885e35cf81dSBarry Smith #undef __FUNCT__ 2886e35cf81dSBarry Smith #define __FUNCT__ "SNESGetLagJacobian" 2887e35cf81dSBarry Smith /*@ 2888e35cf81dSBarry Smith SNESGetLagJacobian - Indicates how often the Jacobian is rebuilt. See SNESGetLagPreconditioner() to determine when the preconditioner is rebuilt 2889e35cf81dSBarry Smith 28903f9fe445SBarry Smith Not Collective 2891e35cf81dSBarry Smith 2892e35cf81dSBarry Smith Input Parameter: 2893e35cf81dSBarry Smith . snes - the SNES context 2894e35cf81dSBarry Smith 2895e35cf81dSBarry Smith Output Parameter: 2896e35cf81dSBarry 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 2897e35cf81dSBarry Smith the Jacobian is built etc. 2898e35cf81dSBarry Smith 2899e35cf81dSBarry Smith Options Database Keys: 2900e35cf81dSBarry Smith . -snes_lag_jacobian <lag> 2901e35cf81dSBarry Smith 2902e35cf81dSBarry Smith Notes: 2903e35cf81dSBarry Smith The default is 1 2904e35cf81dSBarry Smith The jacobian is ALWAYS built in the first iteration of a nonlinear solve unless lag is -1 2905e35cf81dSBarry Smith 2906e35cf81dSBarry Smith Level: intermediate 2907e35cf81dSBarry Smith 2908e35cf81dSBarry Smith .keywords: SNES, nonlinear, set, convergence, tolerances 2909e35cf81dSBarry Smith 2910e35cf81dSBarry Smith .seealso: SNESSetTrustRegionTolerance(), SNESSetLagJacobian(), SNESSetLagPreconditioner(), SNESGetLagPreconditioner() 2911e35cf81dSBarry Smith 2912e35cf81dSBarry Smith @*/ 29137087cfbeSBarry Smith PetscErrorCode SNESGetLagJacobian(SNES snes,PetscInt *lag) 2914e35cf81dSBarry Smith { 2915e35cf81dSBarry Smith PetscFunctionBegin; 29160700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 2917e35cf81dSBarry Smith *lag = snes->lagjacobian; 2918e35cf81dSBarry Smith PetscFunctionReturn(0); 2919e35cf81dSBarry Smith } 2920e35cf81dSBarry Smith 2921e35cf81dSBarry Smith #undef __FUNCT__ 29224a2ae208SSatish Balay #define __FUNCT__ "SNESSetTolerances" 29239b94acceSBarry Smith /*@ 2924d7a720efSLois Curfman McInnes SNESSetTolerances - Sets various parameters used in convergence tests. 29259b94acceSBarry Smith 29263f9fe445SBarry Smith Logically Collective on SNES 2927c7afd0dbSLois Curfman McInnes 29289b94acceSBarry Smith Input Parameters: 2929c7afd0dbSLois Curfman McInnes + snes - the SNES context 293070441072SBarry Smith . abstol - absolute convergence tolerance 293133174efeSLois Curfman McInnes . rtol - relative convergence tolerance 29325358d0d4SBarry Smith . stol - convergence tolerance in terms of the norm of the change in the solution between steps, || delta x || < stol*|| x || 293333174efeSLois Curfman McInnes . maxit - maximum number of iterations 2934c7afd0dbSLois Curfman McInnes - maxf - maximum number of function evaluations 2935fee21e36SBarry Smith 293633174efeSLois Curfman McInnes Options Database Keys: 293770441072SBarry Smith + -snes_atol <abstol> - Sets abstol 2938c7afd0dbSLois Curfman McInnes . -snes_rtol <rtol> - Sets rtol 2939c7afd0dbSLois Curfman McInnes . -snes_stol <stol> - Sets stol 2940c7afd0dbSLois Curfman McInnes . -snes_max_it <maxit> - Sets maxit 2941c7afd0dbSLois Curfman McInnes - -snes_max_funcs <maxf> - Sets maxf 29429b94acceSBarry Smith 2943d7a720efSLois Curfman McInnes Notes: 29449b94acceSBarry Smith The default maximum number of iterations is 50. 29459b94acceSBarry Smith The default maximum number of function evaluations is 1000. 29469b94acceSBarry Smith 294736851e7fSLois Curfman McInnes Level: intermediate 294836851e7fSLois Curfman McInnes 294933174efeSLois Curfman McInnes .keywords: SNES, nonlinear, set, convergence, tolerances 29509b94acceSBarry Smith 29512492ecdbSBarry Smith .seealso: SNESSetTrustRegionTolerance() 29529b94acceSBarry Smith @*/ 29537087cfbeSBarry Smith PetscErrorCode SNESSetTolerances(SNES snes,PetscReal abstol,PetscReal rtol,PetscReal stol,PetscInt maxit,PetscInt maxf) 29549b94acceSBarry Smith { 29553a40ed3dSBarry Smith PetscFunctionBegin; 29560700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 2957c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(snes,abstol,2); 2958c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(snes,rtol,3); 2959c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(snes,stol,4); 2960c5eb9154SBarry Smith PetscValidLogicalCollectiveInt(snes,maxit,5); 2961c5eb9154SBarry Smith PetscValidLogicalCollectiveInt(snes,maxf,6); 2962c5eb9154SBarry Smith 2963ab54825eSJed Brown if (abstol != PETSC_DEFAULT) { 2964ab54825eSJed Brown if (abstol < 0.0) SETERRQ1(((PetscObject)snes)->comm,PETSC_ERR_ARG_OUTOFRANGE,"Absolute tolerance %G must be non-negative",abstol); 2965ab54825eSJed Brown snes->abstol = abstol; 2966ab54825eSJed Brown } 2967ab54825eSJed Brown if (rtol != PETSC_DEFAULT) { 2968ab54825eSJed Brown if (rtol < 0.0 || 1.0 <= rtol) SETERRQ1(((PetscObject)snes)->comm,PETSC_ERR_ARG_OUTOFRANGE,"Relative tolerance %G must be non-negative and less than 1.0",rtol); 2969ab54825eSJed Brown snes->rtol = rtol; 2970ab54825eSJed Brown } 2971ab54825eSJed Brown if (stol != PETSC_DEFAULT) { 2972ab54825eSJed Brown if (stol < 0.0) SETERRQ1(((PetscObject)snes)->comm,PETSC_ERR_ARG_OUTOFRANGE,"Step tolerance %G must be non-negative",stol); 2973c60f73f4SPeter Brune snes->stol = stol; 2974ab54825eSJed Brown } 2975ab54825eSJed Brown if (maxit != PETSC_DEFAULT) { 2976ab54825eSJed Brown if (maxit < 0) SETERRQ1(((PetscObject)snes)->comm,PETSC_ERR_ARG_OUTOFRANGE,"Maximum number of iterations %D must be non-negative",maxit); 2977ab54825eSJed Brown snes->max_its = maxit; 2978ab54825eSJed Brown } 2979ab54825eSJed Brown if (maxf != PETSC_DEFAULT) { 2980ab54825eSJed Brown if (maxf < 0) SETERRQ1(((PetscObject)snes)->comm,PETSC_ERR_ARG_OUTOFRANGE,"Maximum number of function evaluations %D must be non-negative",maxf); 2981ab54825eSJed Brown snes->max_funcs = maxf; 2982ab54825eSJed Brown } 298388976e71SPeter Brune snes->tolerancesset = PETSC_TRUE; 29843a40ed3dSBarry Smith PetscFunctionReturn(0); 29859b94acceSBarry Smith } 29869b94acceSBarry Smith 29874a2ae208SSatish Balay #undef __FUNCT__ 29884a2ae208SSatish Balay #define __FUNCT__ "SNESGetTolerances" 29899b94acceSBarry Smith /*@ 299033174efeSLois Curfman McInnes SNESGetTolerances - Gets various parameters used in convergence tests. 299133174efeSLois Curfman McInnes 2992c7afd0dbSLois Curfman McInnes Not Collective 2993c7afd0dbSLois Curfman McInnes 299433174efeSLois Curfman McInnes Input Parameters: 2995c7afd0dbSLois Curfman McInnes + snes - the SNES context 299685385478SLisandro Dalcin . atol - absolute convergence tolerance 299733174efeSLois Curfman McInnes . rtol - relative convergence tolerance 299833174efeSLois Curfman McInnes . stol - convergence tolerance in terms of the norm 299933174efeSLois Curfman McInnes of the change in the solution between steps 300033174efeSLois Curfman McInnes . maxit - maximum number of iterations 3001c7afd0dbSLois Curfman McInnes - maxf - maximum number of function evaluations 3002fee21e36SBarry Smith 300333174efeSLois Curfman McInnes Notes: 300433174efeSLois Curfman McInnes The user can specify PETSC_NULL for any parameter that is not needed. 300533174efeSLois Curfman McInnes 300636851e7fSLois Curfman McInnes Level: intermediate 300736851e7fSLois Curfman McInnes 300833174efeSLois Curfman McInnes .keywords: SNES, nonlinear, get, convergence, tolerances 300933174efeSLois Curfman McInnes 301033174efeSLois Curfman McInnes .seealso: SNESSetTolerances() 301133174efeSLois Curfman McInnes @*/ 30127087cfbeSBarry Smith PetscErrorCode SNESGetTolerances(SNES snes,PetscReal *atol,PetscReal *rtol,PetscReal *stol,PetscInt *maxit,PetscInt *maxf) 301333174efeSLois Curfman McInnes { 30143a40ed3dSBarry Smith PetscFunctionBegin; 30150700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 301685385478SLisandro Dalcin if (atol) *atol = snes->abstol; 301733174efeSLois Curfman McInnes if (rtol) *rtol = snes->rtol; 3018c60f73f4SPeter Brune if (stol) *stol = snes->stol; 301933174efeSLois Curfman McInnes if (maxit) *maxit = snes->max_its; 302033174efeSLois Curfman McInnes if (maxf) *maxf = snes->max_funcs; 30213a40ed3dSBarry Smith PetscFunctionReturn(0); 302233174efeSLois Curfman McInnes } 302333174efeSLois Curfman McInnes 30244a2ae208SSatish Balay #undef __FUNCT__ 30254a2ae208SSatish Balay #define __FUNCT__ "SNESSetTrustRegionTolerance" 302633174efeSLois Curfman McInnes /*@ 30279b94acceSBarry Smith SNESSetTrustRegionTolerance - Sets the trust region parameter tolerance. 30289b94acceSBarry Smith 30293f9fe445SBarry Smith Logically Collective on SNES 3030fee21e36SBarry Smith 3031c7afd0dbSLois Curfman McInnes Input Parameters: 3032c7afd0dbSLois Curfman McInnes + snes - the SNES context 3033c7afd0dbSLois Curfman McInnes - tol - tolerance 3034c7afd0dbSLois Curfman McInnes 30359b94acceSBarry Smith Options Database Key: 3036c7afd0dbSLois Curfman McInnes . -snes_trtol <tol> - Sets tol 30379b94acceSBarry Smith 303836851e7fSLois Curfman McInnes Level: intermediate 303936851e7fSLois Curfman McInnes 30409b94acceSBarry Smith .keywords: SNES, nonlinear, set, trust region, tolerance 30419b94acceSBarry Smith 30422492ecdbSBarry Smith .seealso: SNESSetTolerances() 30439b94acceSBarry Smith @*/ 30447087cfbeSBarry Smith PetscErrorCode SNESSetTrustRegionTolerance(SNES snes,PetscReal tol) 30459b94acceSBarry Smith { 30463a40ed3dSBarry Smith PetscFunctionBegin; 30470700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 3048c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(snes,tol,2); 30499b94acceSBarry Smith snes->deltatol = tol; 30503a40ed3dSBarry Smith PetscFunctionReturn(0); 30519b94acceSBarry Smith } 30529b94acceSBarry Smith 3053df9fa365SBarry Smith /* 3054df9fa365SBarry Smith Duplicate the lg monitors for SNES from KSP; for some reason with 3055df9fa365SBarry Smith dynamic libraries things don't work under Sun4 if we just use 3056df9fa365SBarry Smith macros instead of functions 3057df9fa365SBarry Smith */ 30584a2ae208SSatish Balay #undef __FUNCT__ 30594619e776SBarry Smith #define __FUNCT__ "SNESMonitorLGResidualNorm" 30604619e776SBarry Smith PetscErrorCode SNESMonitorLGResidualNorm(SNES snes,PetscInt it,PetscReal norm,void *ctx) 3061ce1608b8SBarry Smith { 3062dfbe8321SBarry Smith PetscErrorCode ierr; 3063ce1608b8SBarry Smith 3064ce1608b8SBarry Smith PetscFunctionBegin; 30650700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 30661d1e9da1SBarry Smith ierr = KSPMonitorLGResidualNorm((KSP)snes,it,norm,ctx);CHKERRQ(ierr); 3067ce1608b8SBarry Smith PetscFunctionReturn(0); 3068ce1608b8SBarry Smith } 3069ce1608b8SBarry Smith 30704a2ae208SSatish Balay #undef __FUNCT__ 3071a6570f20SBarry Smith #define __FUNCT__ "SNESMonitorLGCreate" 30727087cfbeSBarry Smith PetscErrorCode SNESMonitorLGCreate(const char host[],const char label[],int x,int y,int m,int n,PetscDrawLG *draw) 3073df9fa365SBarry Smith { 3074dfbe8321SBarry Smith PetscErrorCode ierr; 3075df9fa365SBarry Smith 3076df9fa365SBarry Smith PetscFunctionBegin; 30771d1e9da1SBarry Smith ierr = KSPMonitorLGResidualNormCreate(host,label,x,y,m,n,draw);CHKERRQ(ierr); 3078df9fa365SBarry Smith PetscFunctionReturn(0); 3079df9fa365SBarry Smith } 3080df9fa365SBarry Smith 30814a2ae208SSatish Balay #undef __FUNCT__ 3082a6570f20SBarry Smith #define __FUNCT__ "SNESMonitorLGDestroy" 30836bf464f9SBarry Smith PetscErrorCode SNESMonitorLGDestroy(PetscDrawLG *draw) 3084df9fa365SBarry Smith { 3085dfbe8321SBarry Smith PetscErrorCode ierr; 3086df9fa365SBarry Smith 3087df9fa365SBarry Smith PetscFunctionBegin; 30881d1e9da1SBarry Smith ierr = KSPMonitorLGResidualNormDestroy(draw);CHKERRQ(ierr); 3089df9fa365SBarry Smith PetscFunctionReturn(0); 3090df9fa365SBarry Smith } 3091df9fa365SBarry Smith 30927087cfbeSBarry Smith extern PetscErrorCode SNESMonitorRange_Private(SNES,PetscInt,PetscReal*); 3093b271bb04SBarry Smith #undef __FUNCT__ 3094b271bb04SBarry Smith #define __FUNCT__ "SNESMonitorLGRange" 30957087cfbeSBarry Smith PetscErrorCode SNESMonitorLGRange(SNES snes,PetscInt n,PetscReal rnorm,void *monctx) 3096b271bb04SBarry Smith { 3097b271bb04SBarry Smith PetscDrawLG lg; 3098b271bb04SBarry Smith PetscErrorCode ierr; 3099b271bb04SBarry Smith PetscReal x,y,per; 3100b271bb04SBarry Smith PetscViewer v = (PetscViewer)monctx; 3101b271bb04SBarry Smith static PetscReal prev; /* should be in the context */ 3102b271bb04SBarry Smith PetscDraw draw; 3103b271bb04SBarry Smith 3104459f5d12SBarry Smith PetscFunctionBegin; 3105b271bb04SBarry Smith ierr = PetscViewerDrawGetDrawLG(v,0,&lg);CHKERRQ(ierr); 3106b271bb04SBarry Smith if (!n) {ierr = PetscDrawLGReset(lg);CHKERRQ(ierr);} 3107b271bb04SBarry Smith ierr = PetscDrawLGGetDraw(lg,&draw);CHKERRQ(ierr); 3108b271bb04SBarry Smith ierr = PetscDrawSetTitle(draw,"Residual norm");CHKERRQ(ierr); 3109b271bb04SBarry Smith x = (PetscReal) n; 3110b271bb04SBarry Smith if (rnorm > 0.0) y = log10(rnorm); else y = -15.0; 3111b271bb04SBarry Smith ierr = PetscDrawLGAddPoint(lg,&x,&y);CHKERRQ(ierr); 3112b271bb04SBarry Smith if (n < 20 || !(n % 5)) { 3113b271bb04SBarry Smith ierr = PetscDrawLGDraw(lg);CHKERRQ(ierr); 3114b271bb04SBarry Smith } 3115b271bb04SBarry Smith 3116b271bb04SBarry Smith ierr = PetscViewerDrawGetDrawLG(v,1,&lg);CHKERRQ(ierr); 3117b271bb04SBarry Smith if (!n) {ierr = PetscDrawLGReset(lg);CHKERRQ(ierr);} 3118b271bb04SBarry Smith ierr = PetscDrawLGGetDraw(lg,&draw);CHKERRQ(ierr); 3119b271bb04SBarry Smith ierr = PetscDrawSetTitle(draw,"% elemts > .2*max elemt");CHKERRQ(ierr); 3120b271bb04SBarry Smith ierr = SNESMonitorRange_Private(snes,n,&per);CHKERRQ(ierr); 3121b271bb04SBarry Smith x = (PetscReal) n; 3122b271bb04SBarry Smith y = 100.0*per; 3123b271bb04SBarry Smith ierr = PetscDrawLGAddPoint(lg,&x,&y);CHKERRQ(ierr); 3124b271bb04SBarry Smith if (n < 20 || !(n % 5)) { 3125b271bb04SBarry Smith ierr = PetscDrawLGDraw(lg);CHKERRQ(ierr); 3126b271bb04SBarry Smith } 3127b271bb04SBarry Smith 3128b271bb04SBarry Smith ierr = PetscViewerDrawGetDrawLG(v,2,&lg);CHKERRQ(ierr); 3129b271bb04SBarry Smith if (!n) {prev = rnorm;ierr = PetscDrawLGReset(lg);CHKERRQ(ierr);} 3130b271bb04SBarry Smith ierr = PetscDrawLGGetDraw(lg,&draw);CHKERRQ(ierr); 3131b271bb04SBarry Smith ierr = PetscDrawSetTitle(draw,"(norm -oldnorm)/oldnorm");CHKERRQ(ierr); 3132b271bb04SBarry Smith x = (PetscReal) n; 3133b271bb04SBarry Smith y = (prev - rnorm)/prev; 3134b271bb04SBarry Smith ierr = PetscDrawLGAddPoint(lg,&x,&y);CHKERRQ(ierr); 3135b271bb04SBarry Smith if (n < 20 || !(n % 5)) { 3136b271bb04SBarry Smith ierr = PetscDrawLGDraw(lg);CHKERRQ(ierr); 3137b271bb04SBarry Smith } 3138b271bb04SBarry Smith 3139b271bb04SBarry Smith ierr = PetscViewerDrawGetDrawLG(v,3,&lg);CHKERRQ(ierr); 3140b271bb04SBarry Smith if (!n) {ierr = PetscDrawLGReset(lg);CHKERRQ(ierr);} 3141b271bb04SBarry Smith ierr = PetscDrawLGGetDraw(lg,&draw);CHKERRQ(ierr); 3142b271bb04SBarry Smith ierr = PetscDrawSetTitle(draw,"(norm -oldnorm)/oldnorm*(% > .2 max)");CHKERRQ(ierr); 3143b271bb04SBarry Smith x = (PetscReal) n; 3144b271bb04SBarry Smith y = (prev - rnorm)/(prev*per); 3145b271bb04SBarry Smith if (n > 2) { /*skip initial crazy value */ 3146b271bb04SBarry Smith ierr = PetscDrawLGAddPoint(lg,&x,&y);CHKERRQ(ierr); 3147b271bb04SBarry Smith } 3148b271bb04SBarry Smith if (n < 20 || !(n % 5)) { 3149b271bb04SBarry Smith ierr = PetscDrawLGDraw(lg);CHKERRQ(ierr); 3150b271bb04SBarry Smith } 3151b271bb04SBarry Smith prev = rnorm; 3152b271bb04SBarry Smith PetscFunctionReturn(0); 3153b271bb04SBarry Smith } 3154b271bb04SBarry Smith 3155b271bb04SBarry Smith #undef __FUNCT__ 31567a03ce2fSLisandro Dalcin #define __FUNCT__ "SNESMonitor" 3157228d79bcSJed Brown /*@ 3158228d79bcSJed Brown SNESMonitor - runs the user provided monitor routines, if they exist 3159228d79bcSJed Brown 3160228d79bcSJed Brown Collective on SNES 3161228d79bcSJed Brown 3162228d79bcSJed Brown Input Parameters: 3163228d79bcSJed Brown + snes - nonlinear solver context obtained from SNESCreate() 3164228d79bcSJed Brown . iter - iteration number 3165228d79bcSJed Brown - rnorm - relative norm of the residual 3166228d79bcSJed Brown 3167228d79bcSJed Brown Notes: 3168228d79bcSJed Brown This routine is called by the SNES implementations. 3169228d79bcSJed Brown It does not typically need to be called by the user. 3170228d79bcSJed Brown 3171228d79bcSJed Brown Level: developer 3172228d79bcSJed Brown 3173228d79bcSJed Brown .seealso: SNESMonitorSet() 3174228d79bcSJed Brown @*/ 31757a03ce2fSLisandro Dalcin PetscErrorCode SNESMonitor(SNES snes,PetscInt iter,PetscReal rnorm) 31767a03ce2fSLisandro Dalcin { 31777a03ce2fSLisandro Dalcin PetscErrorCode ierr; 31787a03ce2fSLisandro Dalcin PetscInt i,n = snes->numbermonitors; 31797a03ce2fSLisandro Dalcin 31807a03ce2fSLisandro Dalcin PetscFunctionBegin; 31817a03ce2fSLisandro Dalcin for (i=0; i<n; i++) { 31827a03ce2fSLisandro Dalcin ierr = (*snes->monitor[i])(snes,iter,rnorm,snes->monitorcontext[i]);CHKERRQ(ierr); 31837a03ce2fSLisandro Dalcin } 31847a03ce2fSLisandro Dalcin PetscFunctionReturn(0); 31857a03ce2fSLisandro Dalcin } 31867a03ce2fSLisandro Dalcin 31879b94acceSBarry Smith /* ------------ Routines to set performance monitoring options ----------- */ 31889b94acceSBarry Smith 3189*bf388a1fSBarry Smith /*MC 3190*bf388a1fSBarry Smith SNESMonitorFunction - functional form passed to SNESMonitorSet() to monitor convergence of nonlinear solver 3191*bf388a1fSBarry Smith 3192*bf388a1fSBarry Smith Synopsis: 3193*bf388a1fSBarry Smith #include "petscsnes.h" 3194*bf388a1fSBarry Smith $ PetscErrorCode SNESMonitorFunction(SNES snes,PetscInt its, PetscReal norm,void *mctx) 3195*bf388a1fSBarry Smith 3196*bf388a1fSBarry Smith + snes - the SNES context 3197*bf388a1fSBarry Smith . its - iteration number 3198*bf388a1fSBarry Smith . norm - 2-norm function value (may be estimated) 3199*bf388a1fSBarry Smith - mctx - [optional] monitoring context 3200*bf388a1fSBarry Smith 3201*bf388a1fSBarry Smith .seealso: SNESMonitorSet(), SNESMonitorGet() 3202*bf388a1fSBarry Smith M*/ 3203*bf388a1fSBarry Smith 32044a2ae208SSatish Balay #undef __FUNCT__ 3205a6570f20SBarry Smith #define __FUNCT__ "SNESMonitorSet" 32069b94acceSBarry Smith /*@C 3207a6570f20SBarry Smith SNESMonitorSet - Sets an ADDITIONAL function that is to be used at every 32089b94acceSBarry Smith iteration of the nonlinear solver to display the iteration's 32099b94acceSBarry Smith progress. 32109b94acceSBarry Smith 32113f9fe445SBarry Smith Logically Collective on SNES 3212fee21e36SBarry Smith 3213c7afd0dbSLois Curfman McInnes Input Parameters: 3214c7afd0dbSLois Curfman McInnes + snes - the SNES context 3215*bf388a1fSBarry Smith . SNESMonitorFunction - monitoring routine 3216b8a78c4aSBarry Smith . mctx - [optional] user-defined context for private data for the 3217e8105e01SRichard Katz monitor routine (use PETSC_NULL if no context is desired) 3218b3006f0bSLois Curfman McInnes - monitordestroy - [optional] routine that frees monitor context 3219b3006f0bSLois Curfman McInnes (may be PETSC_NULL) 32209b94acceSBarry Smith 32219665c990SLois Curfman McInnes Options Database Keys: 3222a6570f20SBarry Smith + -snes_monitor - sets SNESMonitorDefault() 32234619e776SBarry Smith . -snes_monitor_lg_residualnorm - sets line graph monitor, 3224a6570f20SBarry Smith uses SNESMonitorLGCreate() 3225cca6129bSJed Brown - -snes_monitor_cancel - cancels all monitors that have 3226c7afd0dbSLois Curfman McInnes been hardwired into a code by 3227a6570f20SBarry Smith calls to SNESMonitorSet(), but 3228c7afd0dbSLois Curfman McInnes does not cancel those set via 3229c7afd0dbSLois Curfman McInnes the options database. 32309665c990SLois Curfman McInnes 3231639f9d9dSBarry Smith Notes: 32326bc08f3fSLois Curfman McInnes Several different monitoring routines may be set by calling 3233a6570f20SBarry Smith SNESMonitorSet() multiple times; all will be called in the 32346bc08f3fSLois Curfman McInnes order in which they were set. 3235639f9d9dSBarry Smith 3236025f1a04SBarry Smith Fortran notes: Only a single monitor function can be set for each SNES object 3237025f1a04SBarry Smith 323836851e7fSLois Curfman McInnes Level: intermediate 323936851e7fSLois Curfman McInnes 32409b94acceSBarry Smith .keywords: SNES, nonlinear, set, monitor 32419b94acceSBarry Smith 3242*bf388a1fSBarry Smith .seealso: SNESMonitorDefault(), SNESMonitorCancel(), SNESMonitorFunction 32439b94acceSBarry Smith @*/ 3244*bf388a1fSBarry Smith PetscErrorCode SNESMonitorSet(SNES snes,PetscErrorCode (*SNESMonitorFunction)(SNES,PetscInt,PetscReal,void*),void *mctx,PetscErrorCode (*monitordestroy)(void**)) 32459b94acceSBarry Smith { 3246b90d0a6eSBarry Smith PetscInt i; 3247649052a6SBarry Smith PetscErrorCode ierr; 3248b90d0a6eSBarry Smith 32493a40ed3dSBarry Smith PetscFunctionBegin; 32500700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 325117186662SBarry Smith if (snes->numbermonitors >= MAXSNESMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many monitors set"); 3252b90d0a6eSBarry Smith for (i=0; i<snes->numbermonitors;i++) { 3253*bf388a1fSBarry Smith if (SNESMonitorFunction == snes->monitor[i] && monitordestroy == snes->monitordestroy[i] && mctx == snes->monitorcontext[i]) { 3254649052a6SBarry Smith if (monitordestroy) { 3255c2efdce3SBarry Smith ierr = (*monitordestroy)(&mctx);CHKERRQ(ierr); 3256649052a6SBarry Smith } 3257b90d0a6eSBarry Smith PetscFunctionReturn(0); 3258b90d0a6eSBarry Smith } 3259b90d0a6eSBarry Smith } 3260*bf388a1fSBarry Smith snes->monitor[snes->numbermonitors] = SNESMonitorFunction; 3261b8a78c4aSBarry Smith snes->monitordestroy[snes->numbermonitors] = monitordestroy; 3262639f9d9dSBarry Smith snes->monitorcontext[snes->numbermonitors++] = (void*)mctx; 32633a40ed3dSBarry Smith PetscFunctionReturn(0); 32649b94acceSBarry Smith } 32659b94acceSBarry Smith 32664a2ae208SSatish Balay #undef __FUNCT__ 3267a6570f20SBarry Smith #define __FUNCT__ "SNESMonitorCancel" 32685cd90555SBarry Smith /*@C 3269a6570f20SBarry Smith SNESMonitorCancel - Clears all the monitor functions for a SNES object. 32705cd90555SBarry Smith 32713f9fe445SBarry Smith Logically Collective on SNES 3272c7afd0dbSLois Curfman McInnes 32735cd90555SBarry Smith Input Parameters: 32745cd90555SBarry Smith . snes - the SNES context 32755cd90555SBarry Smith 32761a480d89SAdministrator Options Database Key: 3277a6570f20SBarry Smith . -snes_monitor_cancel - cancels all monitors that have been hardwired 3278a6570f20SBarry Smith into a code by calls to SNESMonitorSet(), but does not cancel those 3279c7afd0dbSLois Curfman McInnes set via the options database 32805cd90555SBarry Smith 32815cd90555SBarry Smith Notes: 32825cd90555SBarry Smith There is no way to clear one specific monitor from a SNES object. 32835cd90555SBarry Smith 328436851e7fSLois Curfman McInnes Level: intermediate 328536851e7fSLois Curfman McInnes 32865cd90555SBarry Smith .keywords: SNES, nonlinear, set, monitor 32875cd90555SBarry Smith 3288a6570f20SBarry Smith .seealso: SNESMonitorDefault(), SNESMonitorSet() 32895cd90555SBarry Smith @*/ 32907087cfbeSBarry Smith PetscErrorCode SNESMonitorCancel(SNES snes) 32915cd90555SBarry Smith { 3292d952e501SBarry Smith PetscErrorCode ierr; 3293d952e501SBarry Smith PetscInt i; 3294d952e501SBarry Smith 32955cd90555SBarry Smith PetscFunctionBegin; 32960700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 3297d952e501SBarry Smith for (i=0; i<snes->numbermonitors; i++) { 3298d952e501SBarry Smith if (snes->monitordestroy[i]) { 32993c4aec1bSBarry Smith ierr = (*snes->monitordestroy[i])(&snes->monitorcontext[i]);CHKERRQ(ierr); 3300d952e501SBarry Smith } 3301d952e501SBarry Smith } 33025cd90555SBarry Smith snes->numbermonitors = 0; 33035cd90555SBarry Smith PetscFunctionReturn(0); 33045cd90555SBarry Smith } 33055cd90555SBarry Smith 3306*bf388a1fSBarry Smith /*MC 3307*bf388a1fSBarry Smith SNESConvergenceTestFunction - functional form used for testing of convergence of nonlinear solver 3308*bf388a1fSBarry Smith 3309*bf388a1fSBarry Smith Synopsis: 3310*bf388a1fSBarry Smith #include "petscsnes.h" 3311*bf388a1fSBarry Smith $ PetscErrorCode SNESConvergenceTest(SNES snes,PetscInt it,PetscReal xnorm,PetscReal gnorm,PetscReal f,SNESConvergedReason *reason,void *cctx) 3312*bf388a1fSBarry Smith 3313*bf388a1fSBarry Smith + snes - the SNES context 3314*bf388a1fSBarry Smith . it - current iteration (0 is the first and is before any Newton step) 3315*bf388a1fSBarry Smith . cctx - [optional] convergence context 3316*bf388a1fSBarry Smith . reason - reason for convergence/divergence 3317*bf388a1fSBarry Smith . xnorm - 2-norm of current iterate 3318*bf388a1fSBarry Smith . gnorm - 2-norm of current step 3319*bf388a1fSBarry Smith - f - 2-norm of function 3320*bf388a1fSBarry Smith 3321*bf388a1fSBarry Smith 3322*bf388a1fSBarry Smith .seealso: SNESSetConvergenceTest(), SNESGetConvergenceTest() 3323*bf388a1fSBarry Smith M*/ 3324*bf388a1fSBarry Smith 33254a2ae208SSatish Balay #undef __FUNCT__ 33264a2ae208SSatish Balay #define __FUNCT__ "SNESSetConvergenceTest" 33279b94acceSBarry Smith /*@C 33289b94acceSBarry Smith SNESSetConvergenceTest - Sets the function that is to be used 33299b94acceSBarry Smith to test for convergence of the nonlinear iterative solution. 33309b94acceSBarry Smith 33313f9fe445SBarry Smith Logically Collective on SNES 3332fee21e36SBarry Smith 3333c7afd0dbSLois Curfman McInnes Input Parameters: 3334c7afd0dbSLois Curfman McInnes + snes - the SNES context 3335*bf388a1fSBarry Smith . SNESConvergenceTestFunction - routine to test for convergence 33367f7931b9SBarry Smith . cctx - [optional] context for private data for the convergence routine (may be PETSC_NULL) 33377f7931b9SBarry Smith - destroy - [optional] destructor for the context (may be PETSC_NULL; PETSC_NULL_FUNCTION in Fortran) 33389b94acceSBarry Smith 333936851e7fSLois Curfman McInnes Level: advanced 334036851e7fSLois Curfman McInnes 33419b94acceSBarry Smith .keywords: SNES, nonlinear, set, convergence, test 33429b94acceSBarry Smith 3343*bf388a1fSBarry Smith .seealso: SNESDefaultConverged(), SNESSkipConverged(), SNESConvergenceTestFunction 33449b94acceSBarry Smith @*/ 3345*bf388a1fSBarry Smith PetscErrorCode SNESSetConvergenceTest(SNES snes,PetscErrorCode (*SNESConvergenceTestFunction)(SNES,PetscInt,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*),void *cctx,PetscErrorCode (*destroy)(void*)) 33469b94acceSBarry Smith { 33477f7931b9SBarry Smith PetscErrorCode ierr; 33487f7931b9SBarry Smith 33493a40ed3dSBarry Smith PetscFunctionBegin; 33500700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 3351*bf388a1fSBarry Smith if (!SNESConvergenceTestFunction) SNESConvergenceTestFunction = SNESSkipConverged; 33527f7931b9SBarry Smith if (snes->ops->convergeddestroy) { 33537f7931b9SBarry Smith ierr = (*snes->ops->convergeddestroy)(snes->cnvP);CHKERRQ(ierr); 33547f7931b9SBarry Smith } 3355*bf388a1fSBarry Smith snes->ops->converged = SNESConvergenceTestFunction; 33567f7931b9SBarry Smith snes->ops->convergeddestroy = destroy; 335785385478SLisandro Dalcin snes->cnvP = cctx; 33583a40ed3dSBarry Smith PetscFunctionReturn(0); 33599b94acceSBarry Smith } 33609b94acceSBarry Smith 33614a2ae208SSatish Balay #undef __FUNCT__ 33624a2ae208SSatish Balay #define __FUNCT__ "SNESGetConvergedReason" 336352baeb72SSatish Balay /*@ 3364184914b5SBarry Smith SNESGetConvergedReason - Gets the reason the SNES iteration was stopped. 3365184914b5SBarry Smith 3366184914b5SBarry Smith Not Collective 3367184914b5SBarry Smith 3368184914b5SBarry Smith Input Parameter: 3369184914b5SBarry Smith . snes - the SNES context 3370184914b5SBarry Smith 3371184914b5SBarry Smith Output Parameter: 33724d0a8057SBarry Smith . reason - negative value indicates diverged, positive value converged, see SNESConvergedReason or the 3373184914b5SBarry Smith manual pages for the individual convergence tests for complete lists 3374184914b5SBarry Smith 3375184914b5SBarry Smith Level: intermediate 3376184914b5SBarry Smith 3377184914b5SBarry Smith Notes: Can only be called after the call the SNESSolve() is complete. 3378184914b5SBarry Smith 3379184914b5SBarry Smith .keywords: SNES, nonlinear, set, convergence, test 3380184914b5SBarry Smith 338185385478SLisandro Dalcin .seealso: SNESSetConvergenceTest(), SNESConvergedReason 3382184914b5SBarry Smith @*/ 33837087cfbeSBarry Smith PetscErrorCode SNESGetConvergedReason(SNES snes,SNESConvergedReason *reason) 3384184914b5SBarry Smith { 3385184914b5SBarry Smith PetscFunctionBegin; 33860700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 33874482741eSBarry Smith PetscValidPointer(reason,2); 3388184914b5SBarry Smith *reason = snes->reason; 3389184914b5SBarry Smith PetscFunctionReturn(0); 3390184914b5SBarry Smith } 3391184914b5SBarry Smith 33924a2ae208SSatish Balay #undef __FUNCT__ 33934a2ae208SSatish Balay #define __FUNCT__ "SNESSetConvergenceHistory" 3394c9005455SLois Curfman McInnes /*@ 3395c9005455SLois Curfman McInnes SNESSetConvergenceHistory - Sets the array used to hold the convergence history. 3396c9005455SLois Curfman McInnes 33973f9fe445SBarry Smith Logically Collective on SNES 3398fee21e36SBarry Smith 3399c7afd0dbSLois Curfman McInnes Input Parameters: 3400c7afd0dbSLois Curfman McInnes + snes - iterative context obtained from SNESCreate() 34018c7482ecSBarry Smith . a - array to hold history, this array will contain the function norms computed at each step 3402cd5578b5SBarry Smith . its - integer array holds the number of linear iterations for each solve. 3403758f92a0SBarry Smith . na - size of a and its 340464731454SLois Curfman McInnes - reset - PETSC_TRUE indicates each new nonlinear solve resets the history counter to zero, 3405758f92a0SBarry Smith else it continues storing new values for new nonlinear solves after the old ones 3406c7afd0dbSLois Curfman McInnes 3407308dcc3eSBarry Smith Notes: 3408308dcc3eSBarry Smith If 'a' and 'its' are PETSC_NULL then space is allocated for the history. If 'na' PETSC_DECIDE or PETSC_DEFAULT then a 3409308dcc3eSBarry Smith default array of length 10000 is allocated. 3410308dcc3eSBarry Smith 3411c9005455SLois Curfman McInnes This routine is useful, e.g., when running a code for purposes 3412c9005455SLois Curfman McInnes of accurate performance monitoring, when no I/O should be done 3413c9005455SLois Curfman McInnes during the section of code that is being timed. 3414c9005455SLois Curfman McInnes 341536851e7fSLois Curfman McInnes Level: intermediate 341636851e7fSLois Curfman McInnes 3417c9005455SLois Curfman McInnes .keywords: SNES, set, convergence, history 3418758f92a0SBarry Smith 341908405cd6SLois Curfman McInnes .seealso: SNESGetConvergenceHistory() 3420758f92a0SBarry Smith 3421c9005455SLois Curfman McInnes @*/ 34227087cfbeSBarry Smith PetscErrorCode SNESSetConvergenceHistory(SNES snes,PetscReal a[],PetscInt its[],PetscInt na,PetscBool reset) 3423c9005455SLois Curfman McInnes { 3424308dcc3eSBarry Smith PetscErrorCode ierr; 3425308dcc3eSBarry Smith 34263a40ed3dSBarry Smith PetscFunctionBegin; 34270700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 34284482741eSBarry Smith if (na) PetscValidScalarPointer(a,2); 3429a562a398SLisandro Dalcin if (its) PetscValidIntPointer(its,3); 3430308dcc3eSBarry Smith if (na == PETSC_DECIDE || na == PETSC_DEFAULT || !a) { 3431308dcc3eSBarry Smith if (na == PETSC_DECIDE || na == PETSC_DEFAULT) na = 1000; 3432308dcc3eSBarry Smith ierr = PetscMalloc(na*sizeof(PetscReal),&a);CHKERRQ(ierr); 3433308dcc3eSBarry Smith ierr = PetscMalloc(na*sizeof(PetscInt),&its);CHKERRQ(ierr); 3434308dcc3eSBarry Smith snes->conv_malloc = PETSC_TRUE; 3435308dcc3eSBarry Smith } 3436c9005455SLois Curfman McInnes snes->conv_hist = a; 3437758f92a0SBarry Smith snes->conv_hist_its = its; 3438758f92a0SBarry Smith snes->conv_hist_max = na; 3439a12bc48fSLisandro Dalcin snes->conv_hist_len = 0; 3440758f92a0SBarry Smith snes->conv_hist_reset = reset; 3441758f92a0SBarry Smith PetscFunctionReturn(0); 3442758f92a0SBarry Smith } 3443758f92a0SBarry Smith 3444308dcc3eSBarry Smith #if defined(PETSC_HAVE_MATLAB_ENGINE) 3445c6db04a5SJed Brown #include <engine.h> /* MATLAB include file */ 3446c6db04a5SJed Brown #include <mex.h> /* MATLAB include file */ 3447308dcc3eSBarry Smith EXTERN_C_BEGIN 3448308dcc3eSBarry Smith #undef __FUNCT__ 3449308dcc3eSBarry Smith #define __FUNCT__ "SNESGetConvergenceHistoryMatlab" 3450308dcc3eSBarry Smith mxArray *SNESGetConvergenceHistoryMatlab(SNES snes) 3451308dcc3eSBarry Smith { 3452308dcc3eSBarry Smith mxArray *mat; 3453308dcc3eSBarry Smith PetscInt i; 3454308dcc3eSBarry Smith PetscReal *ar; 3455308dcc3eSBarry Smith 3456308dcc3eSBarry Smith PetscFunctionBegin; 3457308dcc3eSBarry Smith mat = mxCreateDoubleMatrix(snes->conv_hist_len,1,mxREAL); 3458308dcc3eSBarry Smith ar = (PetscReal*) mxGetData(mat); 3459308dcc3eSBarry Smith for (i=0; i<snes->conv_hist_len; i++) { 3460308dcc3eSBarry Smith ar[i] = snes->conv_hist[i]; 3461308dcc3eSBarry Smith } 3462308dcc3eSBarry Smith PetscFunctionReturn(mat); 3463308dcc3eSBarry Smith } 3464308dcc3eSBarry Smith EXTERN_C_END 3465308dcc3eSBarry Smith #endif 3466308dcc3eSBarry Smith 34674a2ae208SSatish Balay #undef __FUNCT__ 34684a2ae208SSatish Balay #define __FUNCT__ "SNESGetConvergenceHistory" 34690c4c9dddSBarry Smith /*@C 3470758f92a0SBarry Smith SNESGetConvergenceHistory - Gets the array used to hold the convergence history. 3471758f92a0SBarry Smith 34723f9fe445SBarry Smith Not Collective 3473758f92a0SBarry Smith 3474758f92a0SBarry Smith Input Parameter: 3475758f92a0SBarry Smith . snes - iterative context obtained from SNESCreate() 3476758f92a0SBarry Smith 3477758f92a0SBarry Smith Output Parameters: 3478758f92a0SBarry Smith . a - array to hold history 3479758f92a0SBarry Smith . its - integer array holds the number of linear iterations (or 3480758f92a0SBarry Smith negative if not converged) for each solve. 3481758f92a0SBarry Smith - na - size of a and its 3482758f92a0SBarry Smith 3483758f92a0SBarry Smith Notes: 3484758f92a0SBarry Smith The calling sequence for this routine in Fortran is 3485758f92a0SBarry Smith $ call SNESGetConvergenceHistory(SNES snes, integer na, integer ierr) 3486758f92a0SBarry Smith 3487758f92a0SBarry Smith This routine is useful, e.g., when running a code for purposes 3488758f92a0SBarry Smith of accurate performance monitoring, when no I/O should be done 3489758f92a0SBarry Smith during the section of code that is being timed. 3490758f92a0SBarry Smith 3491758f92a0SBarry Smith Level: intermediate 3492758f92a0SBarry Smith 3493758f92a0SBarry Smith .keywords: SNES, get, convergence, history 3494758f92a0SBarry Smith 3495758f92a0SBarry Smith .seealso: SNESSetConvergencHistory() 3496758f92a0SBarry Smith 3497758f92a0SBarry Smith @*/ 34987087cfbeSBarry Smith PetscErrorCode SNESGetConvergenceHistory(SNES snes,PetscReal *a[],PetscInt *its[],PetscInt *na) 3499758f92a0SBarry Smith { 3500758f92a0SBarry Smith PetscFunctionBegin; 35010700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 3502758f92a0SBarry Smith if (a) *a = snes->conv_hist; 3503758f92a0SBarry Smith if (its) *its = snes->conv_hist_its; 3504758f92a0SBarry Smith if (na) *na = snes->conv_hist_len; 35053a40ed3dSBarry Smith PetscFunctionReturn(0); 3506c9005455SLois Curfman McInnes } 3507c9005455SLois Curfman McInnes 3508e74ef692SMatthew Knepley #undef __FUNCT__ 3509e74ef692SMatthew Knepley #define __FUNCT__ "SNESSetUpdate" 3510ac226902SBarry Smith /*@C 351176b2cf59SMatthew Knepley SNESSetUpdate - Sets the general-purpose update function called 3512eec8f646SJed Brown at the beginning of every iteration of the nonlinear solve. Specifically 35137e4bb74cSBarry Smith it is called just before the Jacobian is "evaluated". 351476b2cf59SMatthew Knepley 35153f9fe445SBarry Smith Logically Collective on SNES 351676b2cf59SMatthew Knepley 351776b2cf59SMatthew Knepley Input Parameters: 351876b2cf59SMatthew Knepley . snes - The nonlinear solver context 351976b2cf59SMatthew Knepley . func - The function 352076b2cf59SMatthew Knepley 352176b2cf59SMatthew Knepley Calling sequence of func: 3522b5d30489SBarry Smith . func (SNES snes, PetscInt step); 352376b2cf59SMatthew Knepley 352476b2cf59SMatthew Knepley . step - The current step of the iteration 352576b2cf59SMatthew Knepley 3526fe97e370SBarry Smith Level: advanced 3527fe97e370SBarry Smith 3528fe97e370SBarry 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() 3529fe97e370SBarry Smith This is not used by most users. 353076b2cf59SMatthew Knepley 353176b2cf59SMatthew Knepley .keywords: SNES, update 3532b5d30489SBarry Smith 353385385478SLisandro Dalcin .seealso SNESDefaultUpdate(), SNESSetJacobian(), SNESSolve() 353476b2cf59SMatthew Knepley @*/ 35357087cfbeSBarry Smith PetscErrorCode SNESSetUpdate(SNES snes, PetscErrorCode (*func)(SNES, PetscInt)) 353676b2cf59SMatthew Knepley { 353776b2cf59SMatthew Knepley PetscFunctionBegin; 35380700a824SBarry Smith PetscValidHeaderSpecific(snes, SNES_CLASSID,1); 3539e7788613SBarry Smith snes->ops->update = func; 354076b2cf59SMatthew Knepley PetscFunctionReturn(0); 354176b2cf59SMatthew Knepley } 354276b2cf59SMatthew Knepley 3543e74ef692SMatthew Knepley #undef __FUNCT__ 3544e74ef692SMatthew Knepley #define __FUNCT__ "SNESDefaultUpdate" 354576b2cf59SMatthew Knepley /*@ 354676b2cf59SMatthew Knepley SNESDefaultUpdate - The default update function which does nothing. 354776b2cf59SMatthew Knepley 354876b2cf59SMatthew Knepley Not collective 354976b2cf59SMatthew Knepley 355076b2cf59SMatthew Knepley Input Parameters: 355176b2cf59SMatthew Knepley . snes - The nonlinear solver context 355276b2cf59SMatthew Knepley . step - The current step of the iteration 355376b2cf59SMatthew Knepley 3554205452f4SMatthew Knepley Level: intermediate 3555205452f4SMatthew Knepley 355676b2cf59SMatthew Knepley .keywords: SNES, update 3557a6570f20SBarry Smith .seealso SNESSetUpdate(), SNESDefaultRhsBC(), SNESDefaultShortolutionBC() 355876b2cf59SMatthew Knepley @*/ 35597087cfbeSBarry Smith PetscErrorCode SNESDefaultUpdate(SNES snes, PetscInt step) 356076b2cf59SMatthew Knepley { 356176b2cf59SMatthew Knepley PetscFunctionBegin; 356276b2cf59SMatthew Knepley PetscFunctionReturn(0); 356376b2cf59SMatthew Knepley } 356476b2cf59SMatthew Knepley 35654a2ae208SSatish Balay #undef __FUNCT__ 35664a2ae208SSatish Balay #define __FUNCT__ "SNESScaleStep_Private" 35679b94acceSBarry Smith /* 35689b94acceSBarry Smith SNESScaleStep_Private - Scales a step so that its length is less than the 35699b94acceSBarry Smith positive parameter delta. 35709b94acceSBarry Smith 35719b94acceSBarry Smith Input Parameters: 3572c7afd0dbSLois Curfman McInnes + snes - the SNES context 35739b94acceSBarry Smith . y - approximate solution of linear system 35749b94acceSBarry Smith . fnorm - 2-norm of current function 3575c7afd0dbSLois Curfman McInnes - delta - trust region size 35769b94acceSBarry Smith 35779b94acceSBarry Smith Output Parameters: 3578c7afd0dbSLois Curfman McInnes + gpnorm - predicted function norm at the new point, assuming local 35799b94acceSBarry Smith linearization. The value is zero if the step lies within the trust 35809b94acceSBarry Smith region, and exceeds zero otherwise. 3581c7afd0dbSLois Curfman McInnes - ynorm - 2-norm of the step 35829b94acceSBarry Smith 35839b94acceSBarry Smith Note: 358404d7464bSBarry Smith For non-trust region methods such as SNESNEWTONLS, the parameter delta 35859b94acceSBarry Smith is set to be the maximum allowable step size. 35869b94acceSBarry Smith 35879b94acceSBarry Smith .keywords: SNES, nonlinear, scale, step 35889b94acceSBarry Smith */ 3589dfbe8321SBarry Smith PetscErrorCode SNESScaleStep_Private(SNES snes,Vec y,PetscReal *fnorm,PetscReal *delta,PetscReal *gpnorm,PetscReal *ynorm) 35909b94acceSBarry Smith { 3591064f8208SBarry Smith PetscReal nrm; 3592ea709b57SSatish Balay PetscScalar cnorm; 3593dfbe8321SBarry Smith PetscErrorCode ierr; 35943a40ed3dSBarry Smith 35953a40ed3dSBarry Smith PetscFunctionBegin; 35960700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 35970700a824SBarry Smith PetscValidHeaderSpecific(y,VEC_CLASSID,2); 3598c9780b6fSBarry Smith PetscCheckSameComm(snes,1,y,2); 3599184914b5SBarry Smith 3600064f8208SBarry Smith ierr = VecNorm(y,NORM_2,&nrm);CHKERRQ(ierr); 3601064f8208SBarry Smith if (nrm > *delta) { 3602064f8208SBarry Smith nrm = *delta/nrm; 3603064f8208SBarry Smith *gpnorm = (1.0 - nrm)*(*fnorm); 3604064f8208SBarry Smith cnorm = nrm; 36052dcb1b2aSMatthew Knepley ierr = VecScale(y,cnorm);CHKERRQ(ierr); 36069b94acceSBarry Smith *ynorm = *delta; 36079b94acceSBarry Smith } else { 36089b94acceSBarry Smith *gpnorm = 0.0; 3609064f8208SBarry Smith *ynorm = nrm; 36109b94acceSBarry Smith } 36113a40ed3dSBarry Smith PetscFunctionReturn(0); 36129b94acceSBarry Smith } 36139b94acceSBarry Smith 36144a2ae208SSatish Balay #undef __FUNCT__ 36154a2ae208SSatish Balay #define __FUNCT__ "SNESSolve" 36166ce558aeSBarry Smith /*@C 3617f69a0ea3SMatthew Knepley SNESSolve - Solves a nonlinear system F(x) = b. 3618f69a0ea3SMatthew Knepley Call SNESSolve() after calling SNESCreate() and optional routines of the form SNESSetXXX(). 36199b94acceSBarry Smith 3620c7afd0dbSLois Curfman McInnes Collective on SNES 3621c7afd0dbSLois Curfman McInnes 3622b2002411SLois Curfman McInnes Input Parameters: 3623c7afd0dbSLois Curfman McInnes + snes - the SNES context 36243cebf274SJed Brown . b - the constant part of the equation F(x) = b, or PETSC_NULL to use zero. 362585385478SLisandro Dalcin - x - the solution vector. 36269b94acceSBarry Smith 3627b2002411SLois Curfman McInnes Notes: 36288ddd3da0SLois Curfman McInnes The user should initialize the vector,x, with the initial guess 36298ddd3da0SLois Curfman McInnes for the nonlinear solve prior to calling SNESSolve. In particular, 36308ddd3da0SLois Curfman McInnes to employ an initial guess of zero, the user should explicitly set 36318ddd3da0SLois Curfman McInnes this vector to zero by calling VecSet(). 36328ddd3da0SLois Curfman McInnes 363336851e7fSLois Curfman McInnes Level: beginner 363436851e7fSLois Curfman McInnes 36359b94acceSBarry Smith .keywords: SNES, nonlinear, solve 36369b94acceSBarry Smith 3637c0df2a02SJed Brown .seealso: SNESCreate(), SNESDestroy(), SNESSetFunction(), SNESSetJacobian(), SNESSetGridSequence(), SNESGetSolution() 36389b94acceSBarry Smith @*/ 36397087cfbeSBarry Smith PetscErrorCode SNESSolve(SNES snes,Vec b,Vec x) 36409b94acceSBarry Smith { 3641dfbe8321SBarry Smith PetscErrorCode ierr; 3642ace3abfcSBarry Smith PetscBool flg; 3643eabae89aSBarry Smith PetscViewer viewer; 3644efd51863SBarry Smith PetscInt grid; 3645a69afd8bSBarry Smith Vec xcreated = PETSC_NULL; 3646caa4e7f2SJed Brown DM dm; 3647cffb1e40SBarry Smith PetscViewerFormat format; 3648052efed2SBarry Smith 36493a40ed3dSBarry Smith PetscFunctionBegin; 36500700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 3651a69afd8bSBarry Smith if (x) PetscValidHeaderSpecific(x,VEC_CLASSID,3); 3652a69afd8bSBarry Smith if (x) PetscCheckSameComm(snes,1,x,3); 36530700a824SBarry Smith if (b) PetscValidHeaderSpecific(b,VEC_CLASSID,2); 365485385478SLisandro Dalcin if (b) PetscCheckSameComm(snes,1,b,2); 365585385478SLisandro Dalcin 3656caa4e7f2SJed Brown if (!x) { 3657caa4e7f2SJed Brown ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr); 3658caa4e7f2SJed Brown ierr = DMCreateGlobalVector(dm,&xcreated);CHKERRQ(ierr); 3659a69afd8bSBarry Smith x = xcreated; 3660a69afd8bSBarry Smith } 3661a69afd8bSBarry Smith 3662a8248277SBarry Smith for (grid=0; grid<snes->gridsequence; grid++) {ierr = PetscViewerASCIIPushTab(PETSC_VIEWER_STDOUT_(((PetscObject)snes)->comm));CHKERRQ(ierr);} 3663efd51863SBarry Smith for (grid=0; grid<snes->gridsequence+1; grid++) { 3664efd51863SBarry Smith 366585385478SLisandro Dalcin /* set solution vector */ 3666efd51863SBarry Smith if (!grid) {ierr = PetscObjectReference((PetscObject)x);CHKERRQ(ierr);} 36676bf464f9SBarry Smith ierr = VecDestroy(&snes->vec_sol);CHKERRQ(ierr); 366885385478SLisandro Dalcin snes->vec_sol = x; 3669caa4e7f2SJed Brown ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr); 3670caa4e7f2SJed Brown 3671caa4e7f2SJed Brown /* set affine vector if provided */ 367285385478SLisandro Dalcin if (b) { ierr = PetscObjectReference((PetscObject)b);CHKERRQ(ierr); } 36736bf464f9SBarry Smith ierr = VecDestroy(&snes->vec_rhs);CHKERRQ(ierr); 367485385478SLisandro Dalcin snes->vec_rhs = b; 367585385478SLisandro Dalcin 367670e92668SMatthew Knepley ierr = SNESSetUp(snes);CHKERRQ(ierr); 36773f149594SLisandro Dalcin 36787eee914bSBarry Smith if (!grid) { 36797eee914bSBarry Smith if (snes->ops->computeinitialguess) { 3680d25893d9SBarry Smith ierr = (*snes->ops->computeinitialguess)(snes,snes->vec_sol,snes->initialguessP);CHKERRQ(ierr); 3681d25893d9SBarry Smith } 3682dd568438SSatish Balay } 3683d25893d9SBarry Smith 3684abc0a331SBarry Smith if (snes->conv_hist_reset) snes->conv_hist_len = 0; 368550ffb88aSMatthew Knepley snes->nfuncs = 0; snes->linear_its = 0; snes->numFailures = 0; 3686d5e45103SBarry Smith 36873f149594SLisandro Dalcin ierr = PetscLogEventBegin(SNES_Solve,snes,0,0,0);CHKERRQ(ierr); 36884936397dSBarry Smith ierr = (*snes->ops->solve)(snes);CHKERRQ(ierr); 368985385478SLisandro Dalcin ierr = PetscLogEventEnd(SNES_Solve,snes,0,0,0);CHKERRQ(ierr); 36904936397dSBarry Smith if (snes->domainerror){ 36914936397dSBarry Smith snes->reason = SNES_DIVERGED_FUNCTION_DOMAIN; 36924936397dSBarry Smith snes->domainerror = PETSC_FALSE; 36934936397dSBarry Smith } 369417186662SBarry Smith if (!snes->reason) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_PLIB,"Internal error, solver returned without setting converged reason"); 36953f149594SLisandro Dalcin 369690d69ab7SBarry Smith flg = PETSC_FALSE; 3697acfcf0e5SJed Brown ierr = PetscOptionsGetBool(((PetscObject)snes)->prefix,"-snes_test_local_min",&flg,PETSC_NULL);CHKERRQ(ierr); 3698da9b6338SBarry Smith if (flg && !PetscPreLoadingOn) { ierr = SNESTestLocalMin(snes);CHKERRQ(ierr); } 36995968eb51SBarry Smith if (snes->printreason) { 3700a8248277SBarry Smith ierr = PetscViewerASCIIAddTab(PETSC_VIEWER_STDOUT_(((PetscObject)snes)->comm),((PetscObject)snes)->tablevel);CHKERRQ(ierr); 37015968eb51SBarry Smith if (snes->reason > 0) { 3702c7e7b494SJed Brown ierr = PetscViewerASCIIPrintf(PETSC_VIEWER_STDOUT_(((PetscObject)snes)->comm),"Nonlinear solve converged due to %s iterations %D\n",SNESConvergedReasons[snes->reason],snes->iter);CHKERRQ(ierr); 37035968eb51SBarry Smith } else { 3704c7e7b494SJed Brown ierr = PetscViewerASCIIPrintf(PETSC_VIEWER_STDOUT_(((PetscObject)snes)->comm),"Nonlinear solve did not converge due to %s iterations %D\n",SNESConvergedReasons[snes->reason],snes->iter);CHKERRQ(ierr); 37055968eb51SBarry Smith } 3706a8248277SBarry Smith ierr = PetscViewerASCIISubtractTab(PETSC_VIEWER_STDOUT_(((PetscObject)snes)->comm),((PetscObject)snes)->tablevel);CHKERRQ(ierr); 37075968eb51SBarry Smith } 37085968eb51SBarry Smith 3709e113a28aSBarry Smith if (snes->errorifnotconverged && snes->reason < 0) SETERRQ(((PetscObject)snes)->comm,PETSC_ERR_NOT_CONVERGED,"SNESSolve has not converged"); 3710efd51863SBarry Smith if (grid < snes->gridsequence) { 3711efd51863SBarry Smith DM fine; 3712efd51863SBarry Smith Vec xnew; 3713efd51863SBarry Smith Mat interp; 3714efd51863SBarry Smith 3715efd51863SBarry Smith ierr = DMRefine(snes->dm,((PetscObject)snes)->comm,&fine);CHKERRQ(ierr); 3716c5c77316SJed Brown if (!fine) SETERRQ(((PetscObject)snes)->comm,PETSC_ERR_ARG_INCOMP,"DMRefine() did not perform any refinement, cannot continue grid sequencing"); 3717e727c939SJed Brown ierr = DMCreateInterpolation(snes->dm,fine,&interp,PETSC_NULL);CHKERRQ(ierr); 3718efd51863SBarry Smith ierr = DMCreateGlobalVector(fine,&xnew);CHKERRQ(ierr); 3719efd51863SBarry Smith ierr = MatInterpolate(interp,x,xnew);CHKERRQ(ierr); 3720c833c3b5SJed Brown ierr = DMInterpolate(snes->dm,interp,fine);CHKERRQ(ierr); 3721efd51863SBarry Smith ierr = MatDestroy(&interp);CHKERRQ(ierr); 3722efd51863SBarry Smith x = xnew; 3723efd51863SBarry Smith 3724efd51863SBarry Smith ierr = SNESReset(snes);CHKERRQ(ierr); 3725efd51863SBarry Smith ierr = SNESSetDM(snes,fine);CHKERRQ(ierr); 3726efd51863SBarry Smith ierr = DMDestroy(&fine);CHKERRQ(ierr); 3727a8248277SBarry Smith ierr = PetscViewerASCIIPopTab(PETSC_VIEWER_STDOUT_(((PetscObject)snes)->comm));CHKERRQ(ierr); 3728efd51863SBarry Smith } 3729efd51863SBarry Smith } 37303f7e2da0SPeter Brune /* monitoring and viewing */ 3731cffb1e40SBarry Smith ierr = PetscOptionsGetViewer(((PetscObject)snes)->comm,((PetscObject)snes)->prefix,"-snes_view",&viewer,&format,&flg);CHKERRQ(ierr); 37323f7e2da0SPeter Brune if (flg && !PetscPreLoadingOn) { 3733cffb1e40SBarry Smith ierr = PetscViewerPushFormat(viewer,format);CHKERRQ(ierr); 37343f7e2da0SPeter Brune ierr = SNESView(snes,viewer);CHKERRQ(ierr); 3735cffb1e40SBarry Smith ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr); 3736cffb1e40SBarry Smith ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr); 373772a02f06SBarry Smith } 37380d2bece7SBarry Smith ierr = VecViewFromOptions(snes->vec_sol,"-snes_view_solution");CHKERRQ(ierr); 37393f7e2da0SPeter Brune 3740a69afd8bSBarry Smith ierr = VecDestroy(&xcreated);CHKERRQ(ierr); 37413a40ed3dSBarry Smith PetscFunctionReturn(0); 37429b94acceSBarry Smith } 37439b94acceSBarry Smith 37449b94acceSBarry Smith /* --------- Internal routines for SNES Package --------- */ 37459b94acceSBarry Smith 37464a2ae208SSatish Balay #undef __FUNCT__ 37474a2ae208SSatish Balay #define __FUNCT__ "SNESSetType" 374882bf6240SBarry Smith /*@C 37494b0e389bSBarry Smith SNESSetType - Sets the method for the nonlinear solver. 37509b94acceSBarry Smith 3751fee21e36SBarry Smith Collective on SNES 3752fee21e36SBarry Smith 3753c7afd0dbSLois Curfman McInnes Input Parameters: 3754c7afd0dbSLois Curfman McInnes + snes - the SNES context 3755454a90a3SBarry Smith - type - a known method 3756c7afd0dbSLois Curfman McInnes 3757c7afd0dbSLois Curfman McInnes Options Database Key: 3758454a90a3SBarry Smith . -snes_type <type> - Sets the method; use -help for a list 375904d7464bSBarry Smith of available methods (for instance, newtonls or newtontr) 3760ae12b187SLois Curfman McInnes 37619b94acceSBarry Smith Notes: 3762e090d566SSatish Balay See "petsc/include/petscsnes.h" for available methods (for instance) 376304d7464bSBarry Smith + SNESNEWTONLS - Newton's method with line search 3764c7afd0dbSLois Curfman McInnes (systems of nonlinear equations) 376504d7464bSBarry Smith . SNESNEWTONTR - Newton's method with trust region 3766c7afd0dbSLois Curfman McInnes (systems of nonlinear equations) 37679b94acceSBarry Smith 3768ae12b187SLois Curfman McInnes Normally, it is best to use the SNESSetFromOptions() command and then 3769ae12b187SLois Curfman McInnes set the SNES solver type from the options database rather than by using 3770ae12b187SLois Curfman McInnes this routine. Using the options database provides the user with 3771ae12b187SLois Curfman McInnes maximum flexibility in evaluating the many nonlinear solvers. 3772ae12b187SLois Curfman McInnes The SNESSetType() routine is provided for those situations where it 3773ae12b187SLois Curfman McInnes is necessary to set the nonlinear solver independently of the command 3774ae12b187SLois Curfman McInnes line or options database. This might be the case, for example, when 3775ae12b187SLois Curfman McInnes the choice of solver changes during the execution of the program, 3776ae12b187SLois Curfman McInnes and the user's application is taking responsibility for choosing the 3777b0a32e0cSBarry Smith appropriate method. 377836851e7fSLois Curfman McInnes 377936851e7fSLois Curfman McInnes Level: intermediate 3780a703fe33SLois Curfman McInnes 3781454a90a3SBarry Smith .keywords: SNES, set, type 3782435da068SBarry Smith 3783435da068SBarry Smith .seealso: SNESType, SNESCreate() 3784435da068SBarry Smith 37859b94acceSBarry Smith @*/ 378619fd82e9SBarry Smith PetscErrorCode SNESSetType(SNES snes,SNESType type) 37879b94acceSBarry Smith { 3788dfbe8321SBarry Smith PetscErrorCode ierr,(*r)(SNES); 3789ace3abfcSBarry Smith PetscBool match; 37903a40ed3dSBarry Smith 37913a40ed3dSBarry Smith PetscFunctionBegin; 37920700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 37934482741eSBarry Smith PetscValidCharPointer(type,2); 379482bf6240SBarry Smith 3795251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)snes,type,&match);CHKERRQ(ierr); 37960f5bd95cSBarry Smith if (match) PetscFunctionReturn(0); 379792ff6ae8SBarry Smith 37984b91b6eaSBarry Smith ierr = PetscFListFind(SNESList,((PetscObject)snes)->comm,type,PETSC_TRUE,(void (**)(void)) &r);CHKERRQ(ierr); 3799e32f2f54SBarry Smith if (!r) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_UNKNOWN_TYPE,"Unable to find requested SNES type %s",type); 380075396ef9SLisandro Dalcin /* Destroy the previous private SNES context */ 3801b5c23020SJed Brown if (snes->ops->destroy) { 3802b5c23020SJed Brown ierr = (*(snes)->ops->destroy)(snes);CHKERRQ(ierr); 3803b5c23020SJed Brown snes->ops->destroy = PETSC_NULL; 3804b5c23020SJed Brown } 380575396ef9SLisandro Dalcin /* Reinitialize function pointers in SNESOps structure */ 380675396ef9SLisandro Dalcin snes->ops->setup = 0; 380775396ef9SLisandro Dalcin snes->ops->solve = 0; 380875396ef9SLisandro Dalcin snes->ops->view = 0; 380975396ef9SLisandro Dalcin snes->ops->setfromoptions = 0; 381075396ef9SLisandro Dalcin snes->ops->destroy = 0; 381175396ef9SLisandro Dalcin /* Call the SNESCreate_XXX routine for this particular Nonlinear solver */ 381275396ef9SLisandro Dalcin snes->setupcalled = PETSC_FALSE; 3813454a90a3SBarry Smith ierr = PetscObjectChangeTypeName((PetscObject)snes,type);CHKERRQ(ierr); 381403bfa161SLisandro Dalcin ierr = (*r)(snes);CHKERRQ(ierr); 38159fb22e1aSBarry Smith #if defined(PETSC_HAVE_AMS) 38169fb22e1aSBarry Smith if (PetscAMSPublishAll) { 38179fb22e1aSBarry Smith ierr = PetscObjectAMSPublish((PetscObject)snes);CHKERRQ(ierr); 38189fb22e1aSBarry Smith } 38199fb22e1aSBarry Smith #endif 38203a40ed3dSBarry Smith PetscFunctionReturn(0); 38219b94acceSBarry Smith } 38229b94acceSBarry Smith 38239b94acceSBarry Smith /* --------------------------------------------------------------------- */ 38244a2ae208SSatish Balay #undef __FUNCT__ 38254a2ae208SSatish Balay #define __FUNCT__ "SNESRegisterDestroy" 382652baeb72SSatish Balay /*@ 38279b94acceSBarry Smith SNESRegisterDestroy - Frees the list of nonlinear solvers that were 3828f1af5d2fSBarry Smith registered by SNESRegisterDynamic(). 38299b94acceSBarry Smith 3830fee21e36SBarry Smith Not Collective 3831fee21e36SBarry Smith 383236851e7fSLois Curfman McInnes Level: advanced 383336851e7fSLois Curfman McInnes 38349b94acceSBarry Smith .keywords: SNES, nonlinear, register, destroy 38359b94acceSBarry Smith 383677f415f2SJed Brown .seealso: SNESRegisterAll() 38379b94acceSBarry Smith @*/ 38387087cfbeSBarry Smith PetscErrorCode SNESRegisterDestroy(void) 38399b94acceSBarry Smith { 3840dfbe8321SBarry Smith PetscErrorCode ierr; 384182bf6240SBarry Smith 38423a40ed3dSBarry Smith PetscFunctionBegin; 38431441b1d3SBarry Smith ierr = PetscFListDestroy(&SNESList);CHKERRQ(ierr); 38444c49b128SBarry Smith SNESRegisterAllCalled = PETSC_FALSE; 38453a40ed3dSBarry Smith PetscFunctionReturn(0); 38469b94acceSBarry Smith } 38479b94acceSBarry Smith 38484a2ae208SSatish Balay #undef __FUNCT__ 38494a2ae208SSatish Balay #define __FUNCT__ "SNESGetType" 38509b94acceSBarry Smith /*@C 38519a28b0a6SLois Curfman McInnes SNESGetType - Gets the SNES method type and name (as a string). 38529b94acceSBarry Smith 3853c7afd0dbSLois Curfman McInnes Not Collective 3854c7afd0dbSLois Curfman McInnes 38559b94acceSBarry Smith Input Parameter: 38564b0e389bSBarry Smith . snes - nonlinear solver context 38579b94acceSBarry Smith 38589b94acceSBarry Smith Output Parameter: 38593a7fca6bSBarry Smith . type - SNES method (a character string) 38609b94acceSBarry Smith 386136851e7fSLois Curfman McInnes Level: intermediate 386236851e7fSLois Curfman McInnes 3863454a90a3SBarry Smith .keywords: SNES, nonlinear, get, type, name 38649b94acceSBarry Smith @*/ 386519fd82e9SBarry Smith PetscErrorCode SNESGetType(SNES snes,SNESType *type) 38669b94acceSBarry Smith { 38673a40ed3dSBarry Smith PetscFunctionBegin; 38680700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 38694482741eSBarry Smith PetscValidPointer(type,2); 38707adad957SLisandro Dalcin *type = ((PetscObject)snes)->type_name; 38713a40ed3dSBarry Smith PetscFunctionReturn(0); 38729b94acceSBarry Smith } 38739b94acceSBarry Smith 38744a2ae208SSatish Balay #undef __FUNCT__ 38754a2ae208SSatish Balay #define __FUNCT__ "SNESGetSolution" 387652baeb72SSatish Balay /*@ 38779b94acceSBarry Smith SNESGetSolution - Returns the vector where the approximate solution is 3878c0df2a02SJed Brown stored. This is the fine grid solution when using SNESSetGridSequence(). 38799b94acceSBarry Smith 3880c7afd0dbSLois Curfman McInnes Not Collective, but Vec is parallel if SNES is parallel 3881c7afd0dbSLois Curfman McInnes 38829b94acceSBarry Smith Input Parameter: 38839b94acceSBarry Smith . snes - the SNES context 38849b94acceSBarry Smith 38859b94acceSBarry Smith Output Parameter: 38869b94acceSBarry Smith . x - the solution 38879b94acceSBarry Smith 388870e92668SMatthew Knepley Level: intermediate 388936851e7fSLois Curfman McInnes 38909b94acceSBarry Smith .keywords: SNES, nonlinear, get, solution 38919b94acceSBarry Smith 389285385478SLisandro Dalcin .seealso: SNESGetSolutionUpdate(), SNESGetFunction() 38939b94acceSBarry Smith @*/ 38947087cfbeSBarry Smith PetscErrorCode SNESGetSolution(SNES snes,Vec *x) 38959b94acceSBarry Smith { 38963a40ed3dSBarry Smith PetscFunctionBegin; 38970700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 38984482741eSBarry Smith PetscValidPointer(x,2); 389985385478SLisandro Dalcin *x = snes->vec_sol; 390070e92668SMatthew Knepley PetscFunctionReturn(0); 390170e92668SMatthew Knepley } 390270e92668SMatthew Knepley 390370e92668SMatthew Knepley #undef __FUNCT__ 39044a2ae208SSatish Balay #define __FUNCT__ "SNESGetSolutionUpdate" 390552baeb72SSatish Balay /*@ 39069b94acceSBarry Smith SNESGetSolutionUpdate - Returns the vector where the solution update is 39079b94acceSBarry Smith stored. 39089b94acceSBarry Smith 3909c7afd0dbSLois Curfman McInnes Not Collective, but Vec is parallel if SNES is parallel 3910c7afd0dbSLois Curfman McInnes 39119b94acceSBarry Smith Input Parameter: 39129b94acceSBarry Smith . snes - the SNES context 39139b94acceSBarry Smith 39149b94acceSBarry Smith Output Parameter: 39159b94acceSBarry Smith . x - the solution update 39169b94acceSBarry Smith 391736851e7fSLois Curfman McInnes Level: advanced 391836851e7fSLois Curfman McInnes 39199b94acceSBarry Smith .keywords: SNES, nonlinear, get, solution, update 39209b94acceSBarry Smith 392185385478SLisandro Dalcin .seealso: SNESGetSolution(), SNESGetFunction() 39229b94acceSBarry Smith @*/ 39237087cfbeSBarry Smith PetscErrorCode SNESGetSolutionUpdate(SNES snes,Vec *x) 39249b94acceSBarry Smith { 39253a40ed3dSBarry Smith PetscFunctionBegin; 39260700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 39274482741eSBarry Smith PetscValidPointer(x,2); 392885385478SLisandro Dalcin *x = snes->vec_sol_update; 39293a40ed3dSBarry Smith PetscFunctionReturn(0); 39309b94acceSBarry Smith } 39319b94acceSBarry Smith 39324a2ae208SSatish Balay #undef __FUNCT__ 39334a2ae208SSatish Balay #define __FUNCT__ "SNESGetFunction" 39349b94acceSBarry Smith /*@C 39353638b69dSLois Curfman McInnes SNESGetFunction - Returns the vector where the function is stored. 39369b94acceSBarry Smith 3937a63bb30eSJed Brown Not Collective, but Vec is parallel if SNES is parallel. Collective if Vec is requested, but has not been created yet. 3938c7afd0dbSLois Curfman McInnes 39399b94acceSBarry Smith Input Parameter: 39409b94acceSBarry Smith . snes - the SNES context 39419b94acceSBarry Smith 39429b94acceSBarry Smith Output Parameter: 3943*bf388a1fSBarry Smith + r - the vector that is used to store residuals (or PETSC_NULL if you don't want it) 3944*bf388a1fSBarry Smith . SNESFunction- the function (or PETSC_NULL if you don't want it) 3945*bf388a1fSBarry Smith - ctx - the function context (or PETSC_NULL if you don't want it) 39469b94acceSBarry Smith 394736851e7fSLois Curfman McInnes Level: advanced 394836851e7fSLois Curfman McInnes 3949a86d99e1SLois Curfman McInnes .keywords: SNES, nonlinear, get, function 39509b94acceSBarry Smith 3951*bf388a1fSBarry Smith .seealso: SNESSetFunction(), SNESGetSolution(), SNESFunction 39529b94acceSBarry Smith @*/ 3953*bf388a1fSBarry Smith PetscErrorCode SNESGetFunction(SNES snes,Vec *r,PetscErrorCode (**SNESFunction)(SNES,Vec,Vec,void*),void **ctx) 39549b94acceSBarry Smith { 3955a63bb30eSJed Brown PetscErrorCode ierr; 39566cab3a1bSJed Brown DM dm; 3957a63bb30eSJed Brown 39583a40ed3dSBarry Smith PetscFunctionBegin; 39590700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 3960a63bb30eSJed Brown if (r) { 3961a63bb30eSJed Brown if (!snes->vec_func) { 3962a63bb30eSJed Brown if (snes->vec_rhs) { 3963a63bb30eSJed Brown ierr = VecDuplicate(snes->vec_rhs,&snes->vec_func);CHKERRQ(ierr); 3964a63bb30eSJed Brown } else if (snes->vec_sol) { 3965a63bb30eSJed Brown ierr = VecDuplicate(snes->vec_sol,&snes->vec_func);CHKERRQ(ierr); 3966a63bb30eSJed Brown } else if (snes->dm) { 3967a63bb30eSJed Brown ierr = DMCreateGlobalVector(snes->dm,&snes->vec_func);CHKERRQ(ierr); 3968a63bb30eSJed Brown } 3969a63bb30eSJed Brown } 3970a63bb30eSJed Brown *r = snes->vec_func; 3971a63bb30eSJed Brown } 39726cab3a1bSJed Brown ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr); 3973*bf388a1fSBarry Smith ierr = DMSNESGetFunction(dm,SNESFunction,ctx);CHKERRQ(ierr); 39743a40ed3dSBarry Smith PetscFunctionReturn(0); 39759b94acceSBarry Smith } 39769b94acceSBarry Smith 3977c79ef259SPeter Brune /*@C 3978c79ef259SPeter Brune SNESGetGS - Returns the GS function and context. 3979c79ef259SPeter Brune 3980c79ef259SPeter Brune Input Parameter: 3981c79ef259SPeter Brune . snes - the SNES context 3982c79ef259SPeter Brune 3983c79ef259SPeter Brune Output Parameter: 3984*bf388a1fSBarry Smith + SNESGSFunction - the function (or PETSC_NULL) 3985c79ef259SPeter Brune - ctx - the function context (or PETSC_NULL) 3986c79ef259SPeter Brune 3987c79ef259SPeter Brune Level: advanced 3988c79ef259SPeter Brune 3989c79ef259SPeter Brune .keywords: SNES, nonlinear, get, function 3990c79ef259SPeter Brune 3991c79ef259SPeter Brune .seealso: SNESSetGS(), SNESGetFunction() 3992c79ef259SPeter Brune @*/ 3993c79ef259SPeter Brune 39944a2ae208SSatish Balay #undef __FUNCT__ 3995646217ecSPeter Brune #define __FUNCT__ "SNESGetGS" 3996*bf388a1fSBarry Smith PetscErrorCode SNESGetGS (SNES snes, PetscErrorCode (**SNESGSFunction)(SNES, Vec, Vec, void*), void ** ctx) 3997646217ecSPeter Brune { 39986cab3a1bSJed Brown PetscErrorCode ierr; 39996cab3a1bSJed Brown DM dm; 40006cab3a1bSJed Brown 4001646217ecSPeter Brune PetscFunctionBegin; 4002646217ecSPeter Brune PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 40036cab3a1bSJed Brown ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr); 4004*bf388a1fSBarry Smith ierr = DMSNESGetGS(dm,SNESGSFunction,ctx);CHKERRQ(ierr); 4005646217ecSPeter Brune PetscFunctionReturn(0); 4006646217ecSPeter Brune } 4007646217ecSPeter Brune 40084a2ae208SSatish Balay #undef __FUNCT__ 40094a2ae208SSatish Balay #define __FUNCT__ "SNESSetOptionsPrefix" 40103c7409f5SSatish Balay /*@C 40113c7409f5SSatish Balay SNESSetOptionsPrefix - Sets the prefix used for searching for all 4012d850072dSLois Curfman McInnes SNES options in the database. 40133c7409f5SSatish Balay 40143f9fe445SBarry Smith Logically Collective on SNES 4015fee21e36SBarry Smith 4016c7afd0dbSLois Curfman McInnes Input Parameter: 4017c7afd0dbSLois Curfman McInnes + snes - the SNES context 4018c7afd0dbSLois Curfman McInnes - prefix - the prefix to prepend to all option names 4019c7afd0dbSLois Curfman McInnes 4020d850072dSLois Curfman McInnes Notes: 4021a83b1b31SSatish Balay A hyphen (-) must NOT be given at the beginning of the prefix name. 4022c7afd0dbSLois Curfman McInnes The first character of all runtime options is AUTOMATICALLY the hyphen. 4023d850072dSLois Curfman McInnes 402436851e7fSLois Curfman McInnes Level: advanced 402536851e7fSLois Curfman McInnes 40263c7409f5SSatish Balay .keywords: SNES, set, options, prefix, database 4027a86d99e1SLois Curfman McInnes 4028a86d99e1SLois Curfman McInnes .seealso: SNESSetFromOptions() 40293c7409f5SSatish Balay @*/ 40307087cfbeSBarry Smith PetscErrorCode SNESSetOptionsPrefix(SNES snes,const char prefix[]) 40313c7409f5SSatish Balay { 4032dfbe8321SBarry Smith PetscErrorCode ierr; 40333c7409f5SSatish Balay 40343a40ed3dSBarry Smith PetscFunctionBegin; 40350700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 4036639f9d9dSBarry Smith ierr = PetscObjectSetOptionsPrefix((PetscObject)snes,prefix);CHKERRQ(ierr); 40371cee3971SBarry Smith if (!snes->ksp) {ierr = SNESGetKSP(snes,&snes->ksp);CHKERRQ(ierr);} 403835f5d045SPeter Brune if (snes->linesearch) { 403935f5d045SPeter Brune ierr = SNESGetSNESLineSearch(snes,&snes->linesearch);CHKERRQ(ierr); 404008b6c495SPeter Brune ierr = PetscObjectSetOptionsPrefix((PetscObject)snes->linesearch,prefix);CHKERRQ(ierr); 404135f5d045SPeter Brune } 404235f5d045SPeter Brune ierr = KSPSetOptionsPrefix(snes->ksp,prefix);CHKERRQ(ierr); 40433a40ed3dSBarry Smith PetscFunctionReturn(0); 40443c7409f5SSatish Balay } 40453c7409f5SSatish Balay 40464a2ae208SSatish Balay #undef __FUNCT__ 40474a2ae208SSatish Balay #define __FUNCT__ "SNESAppendOptionsPrefix" 40483c7409f5SSatish Balay /*@C 4049f525115eSLois Curfman McInnes SNESAppendOptionsPrefix - Appends to the prefix used for searching for all 4050d850072dSLois Curfman McInnes SNES options in the database. 40513c7409f5SSatish Balay 40523f9fe445SBarry Smith Logically Collective on SNES 4053fee21e36SBarry Smith 4054c7afd0dbSLois Curfman McInnes Input Parameters: 4055c7afd0dbSLois Curfman McInnes + snes - the SNES context 4056c7afd0dbSLois Curfman McInnes - prefix - the prefix to prepend to all option names 4057c7afd0dbSLois Curfman McInnes 4058d850072dSLois Curfman McInnes Notes: 4059a83b1b31SSatish Balay A hyphen (-) must NOT be given at the beginning of the prefix name. 4060c7afd0dbSLois Curfman McInnes The first character of all runtime options is AUTOMATICALLY the hyphen. 4061d850072dSLois Curfman McInnes 406236851e7fSLois Curfman McInnes Level: advanced 406336851e7fSLois Curfman McInnes 40643c7409f5SSatish Balay .keywords: SNES, append, options, prefix, database 4065a86d99e1SLois Curfman McInnes 4066a86d99e1SLois Curfman McInnes .seealso: SNESGetOptionsPrefix() 40673c7409f5SSatish Balay @*/ 40687087cfbeSBarry Smith PetscErrorCode SNESAppendOptionsPrefix(SNES snes,const char prefix[]) 40693c7409f5SSatish Balay { 4070dfbe8321SBarry Smith PetscErrorCode ierr; 40713c7409f5SSatish Balay 40723a40ed3dSBarry Smith PetscFunctionBegin; 40730700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 4074639f9d9dSBarry Smith ierr = PetscObjectAppendOptionsPrefix((PetscObject)snes,prefix);CHKERRQ(ierr); 40751cee3971SBarry Smith if (!snes->ksp) {ierr = SNESGetKSP(snes,&snes->ksp);CHKERRQ(ierr);} 407635f5d045SPeter Brune if (snes->linesearch) { 407735f5d045SPeter Brune ierr = SNESGetSNESLineSearch(snes,&snes->linesearch);CHKERRQ(ierr); 407808b6c495SPeter Brune ierr = PetscObjectAppendOptionsPrefix((PetscObject)snes->linesearch,prefix);CHKERRQ(ierr); 407935f5d045SPeter Brune } 408035f5d045SPeter Brune ierr = KSPAppendOptionsPrefix(snes->ksp,prefix);CHKERRQ(ierr); 40813a40ed3dSBarry Smith PetscFunctionReturn(0); 40823c7409f5SSatish Balay } 40833c7409f5SSatish Balay 40844a2ae208SSatish Balay #undef __FUNCT__ 40854a2ae208SSatish Balay #define __FUNCT__ "SNESGetOptionsPrefix" 40869ab63eb5SSatish Balay /*@C 40873c7409f5SSatish Balay SNESGetOptionsPrefix - Sets the prefix used for searching for all 40883c7409f5SSatish Balay SNES options in the database. 40893c7409f5SSatish Balay 4090c7afd0dbSLois Curfman McInnes Not Collective 4091c7afd0dbSLois Curfman McInnes 40923c7409f5SSatish Balay Input Parameter: 40933c7409f5SSatish Balay . snes - the SNES context 40943c7409f5SSatish Balay 40953c7409f5SSatish Balay Output Parameter: 40963c7409f5SSatish Balay . prefix - pointer to the prefix string used 40973c7409f5SSatish Balay 40984ef407dbSRichard Tran Mills Notes: On the fortran side, the user should pass in a string 'prefix' of 40999ab63eb5SSatish Balay sufficient length to hold the prefix. 41009ab63eb5SSatish Balay 410136851e7fSLois Curfman McInnes Level: advanced 410236851e7fSLois Curfman McInnes 41033c7409f5SSatish Balay .keywords: SNES, get, options, prefix, database 4104a86d99e1SLois Curfman McInnes 4105a86d99e1SLois Curfman McInnes .seealso: SNESAppendOptionsPrefix() 41063c7409f5SSatish Balay @*/ 41077087cfbeSBarry Smith PetscErrorCode SNESGetOptionsPrefix(SNES snes,const char *prefix[]) 41083c7409f5SSatish Balay { 4109dfbe8321SBarry Smith PetscErrorCode ierr; 41103c7409f5SSatish Balay 41113a40ed3dSBarry Smith PetscFunctionBegin; 41120700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 4113639f9d9dSBarry Smith ierr = PetscObjectGetOptionsPrefix((PetscObject)snes,prefix);CHKERRQ(ierr); 41143a40ed3dSBarry Smith PetscFunctionReturn(0); 41153c7409f5SSatish Balay } 41163c7409f5SSatish Balay 4117b2002411SLois Curfman McInnes 41184a2ae208SSatish Balay #undef __FUNCT__ 41194a2ae208SSatish Balay #define __FUNCT__ "SNESRegister" 41203cea93caSBarry Smith /*@C 41213cea93caSBarry Smith SNESRegister - See SNESRegisterDynamic() 41223cea93caSBarry Smith 41237f6c08e0SMatthew Knepley Level: advanced 41243cea93caSBarry Smith @*/ 41257087cfbeSBarry Smith PetscErrorCode SNESRegister(const char sname[],const char path[],const char name[],PetscErrorCode (*function)(SNES)) 4126b2002411SLois Curfman McInnes { 4127e2d1d2b7SBarry Smith char fullname[PETSC_MAX_PATH_LEN]; 4128dfbe8321SBarry Smith PetscErrorCode ierr; 4129b2002411SLois Curfman McInnes 4130b2002411SLois Curfman McInnes PetscFunctionBegin; 4131b0a32e0cSBarry Smith ierr = PetscFListConcat(path,name,fullname);CHKERRQ(ierr); 4132c134de8dSSatish Balay ierr = PetscFListAdd(&SNESList,sname,fullname,(void (*)(void))function);CHKERRQ(ierr); 4133b2002411SLois Curfman McInnes PetscFunctionReturn(0); 4134b2002411SLois Curfman McInnes } 4135da9b6338SBarry Smith 4136da9b6338SBarry Smith #undef __FUNCT__ 4137da9b6338SBarry Smith #define __FUNCT__ "SNESTestLocalMin" 41387087cfbeSBarry Smith PetscErrorCode SNESTestLocalMin(SNES snes) 4139da9b6338SBarry Smith { 4140dfbe8321SBarry Smith PetscErrorCode ierr; 414177431f27SBarry Smith PetscInt N,i,j; 4142da9b6338SBarry Smith Vec u,uh,fh; 4143da9b6338SBarry Smith PetscScalar value; 4144da9b6338SBarry Smith PetscReal norm; 4145da9b6338SBarry Smith 4146da9b6338SBarry Smith PetscFunctionBegin; 4147da9b6338SBarry Smith ierr = SNESGetSolution(snes,&u);CHKERRQ(ierr); 4148da9b6338SBarry Smith ierr = VecDuplicate(u,&uh);CHKERRQ(ierr); 4149da9b6338SBarry Smith ierr = VecDuplicate(u,&fh);CHKERRQ(ierr); 4150da9b6338SBarry Smith 4151da9b6338SBarry Smith /* currently only works for sequential */ 415222d28d08SBarry Smith ierr = PetscPrintf(PETSC_COMM_WORLD,"Testing FormFunction() for local min\n");CHKERRQ(ierr); 4153da9b6338SBarry Smith ierr = VecGetSize(u,&N);CHKERRQ(ierr); 4154da9b6338SBarry Smith for (i=0; i<N; i++) { 4155da9b6338SBarry Smith ierr = VecCopy(u,uh);CHKERRQ(ierr); 415677431f27SBarry Smith ierr = PetscPrintf(PETSC_COMM_WORLD,"i = %D\n",i);CHKERRQ(ierr); 4157da9b6338SBarry Smith for (j=-10; j<11; j++) { 4158ccae9161SBarry Smith value = PetscSign(j)*exp(PetscAbs(j)-10.0); 4159da9b6338SBarry Smith ierr = VecSetValue(uh,i,value,ADD_VALUES);CHKERRQ(ierr); 41603ab0aad5SBarry Smith ierr = SNESComputeFunction(snes,uh,fh);CHKERRQ(ierr); 4161da9b6338SBarry Smith ierr = VecNorm(fh,NORM_2,&norm);CHKERRQ(ierr); 416277431f27SBarry Smith ierr = PetscPrintf(PETSC_COMM_WORLD," j norm %D %18.16e\n",j,norm);CHKERRQ(ierr); 4163da9b6338SBarry Smith value = -value; 4164da9b6338SBarry Smith ierr = VecSetValue(uh,i,value,ADD_VALUES);CHKERRQ(ierr); 4165da9b6338SBarry Smith } 4166da9b6338SBarry Smith } 41676bf464f9SBarry Smith ierr = VecDestroy(&uh);CHKERRQ(ierr); 41686bf464f9SBarry Smith ierr = VecDestroy(&fh);CHKERRQ(ierr); 4169da9b6338SBarry Smith PetscFunctionReturn(0); 4170da9b6338SBarry Smith } 417171f87433Sdalcinl 417271f87433Sdalcinl #undef __FUNCT__ 4173fa9f3622SBarry Smith #define __FUNCT__ "SNESKSPSetUseEW" 417471f87433Sdalcinl /*@ 4175fa9f3622SBarry Smith SNESKSPSetUseEW - Sets SNES use Eisenstat-Walker method for 417671f87433Sdalcinl computing relative tolerance for linear solvers within an inexact 417771f87433Sdalcinl Newton method. 417871f87433Sdalcinl 41793f9fe445SBarry Smith Logically Collective on SNES 418071f87433Sdalcinl 418171f87433Sdalcinl Input Parameters: 418271f87433Sdalcinl + snes - SNES context 418371f87433Sdalcinl - flag - PETSC_TRUE or PETSC_FALSE 418471f87433Sdalcinl 418564ba62caSBarry Smith Options Database: 418664ba62caSBarry Smith + -snes_ksp_ew - use Eisenstat-Walker method for determining linear system convergence 418764ba62caSBarry Smith . -snes_ksp_ew_version ver - version of Eisenstat-Walker method 418864ba62caSBarry Smith . -snes_ksp_ew_rtol0 <rtol0> - Sets rtol0 418964ba62caSBarry Smith . -snes_ksp_ew_rtolmax <rtolmax> - Sets rtolmax 419064ba62caSBarry Smith . -snes_ksp_ew_gamma <gamma> - Sets gamma 419164ba62caSBarry Smith . -snes_ksp_ew_alpha <alpha> - Sets alpha 419264ba62caSBarry Smith . -snes_ksp_ew_alpha2 <alpha2> - Sets alpha2 419364ba62caSBarry Smith - -snes_ksp_ew_threshold <threshold> - Sets threshold 419464ba62caSBarry Smith 419571f87433Sdalcinl Notes: 419671f87433Sdalcinl Currently, the default is to use a constant relative tolerance for 419771f87433Sdalcinl the inner linear solvers. Alternatively, one can use the 419871f87433Sdalcinl Eisenstat-Walker method, where the relative convergence tolerance 419971f87433Sdalcinl is reset at each Newton iteration according progress of the nonlinear 420071f87433Sdalcinl solver. 420171f87433Sdalcinl 420271f87433Sdalcinl Level: advanced 420371f87433Sdalcinl 420471f87433Sdalcinl Reference: 420571f87433Sdalcinl S. C. Eisenstat and H. F. Walker, "Choosing the forcing terms in an 420671f87433Sdalcinl inexact Newton method", SISC 17 (1), pp.16-32, 1996. 420771f87433Sdalcinl 420871f87433Sdalcinl .keywords: SNES, KSP, Eisenstat, Walker, convergence, test, inexact, Newton 420971f87433Sdalcinl 4210fa9f3622SBarry Smith .seealso: SNESKSPGetUseEW(), SNESKSPGetParametersEW(), SNESKSPSetParametersEW() 421171f87433Sdalcinl @*/ 42127087cfbeSBarry Smith PetscErrorCode SNESKSPSetUseEW(SNES snes,PetscBool flag) 421371f87433Sdalcinl { 421471f87433Sdalcinl PetscFunctionBegin; 42150700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 4216acfcf0e5SJed Brown PetscValidLogicalCollectiveBool(snes,flag,2); 421771f87433Sdalcinl snes->ksp_ewconv = flag; 421871f87433Sdalcinl PetscFunctionReturn(0); 421971f87433Sdalcinl } 422071f87433Sdalcinl 422171f87433Sdalcinl #undef __FUNCT__ 4222fa9f3622SBarry Smith #define __FUNCT__ "SNESKSPGetUseEW" 422371f87433Sdalcinl /*@ 4224fa9f3622SBarry Smith SNESKSPGetUseEW - Gets if SNES is using Eisenstat-Walker method 422571f87433Sdalcinl for computing relative tolerance for linear solvers within an 422671f87433Sdalcinl inexact Newton method. 422771f87433Sdalcinl 422871f87433Sdalcinl Not Collective 422971f87433Sdalcinl 423071f87433Sdalcinl Input Parameter: 423171f87433Sdalcinl . snes - SNES context 423271f87433Sdalcinl 423371f87433Sdalcinl Output Parameter: 423471f87433Sdalcinl . flag - PETSC_TRUE or PETSC_FALSE 423571f87433Sdalcinl 423671f87433Sdalcinl Notes: 423771f87433Sdalcinl Currently, the default is to use a constant relative tolerance for 423871f87433Sdalcinl the inner linear solvers. Alternatively, one can use the 423971f87433Sdalcinl Eisenstat-Walker method, where the relative convergence tolerance 424071f87433Sdalcinl is reset at each Newton iteration according progress of the nonlinear 424171f87433Sdalcinl solver. 424271f87433Sdalcinl 424371f87433Sdalcinl Level: advanced 424471f87433Sdalcinl 424571f87433Sdalcinl Reference: 424671f87433Sdalcinl S. C. Eisenstat and H. F. Walker, "Choosing the forcing terms in an 424771f87433Sdalcinl inexact Newton method", SISC 17 (1), pp.16-32, 1996. 424871f87433Sdalcinl 424971f87433Sdalcinl .keywords: SNES, KSP, Eisenstat, Walker, convergence, test, inexact, Newton 425071f87433Sdalcinl 4251fa9f3622SBarry Smith .seealso: SNESKSPSetUseEW(), SNESKSPGetParametersEW(), SNESKSPSetParametersEW() 425271f87433Sdalcinl @*/ 42537087cfbeSBarry Smith PetscErrorCode SNESKSPGetUseEW(SNES snes, PetscBool *flag) 425471f87433Sdalcinl { 425571f87433Sdalcinl PetscFunctionBegin; 42560700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 425771f87433Sdalcinl PetscValidPointer(flag,2); 425871f87433Sdalcinl *flag = snes->ksp_ewconv; 425971f87433Sdalcinl PetscFunctionReturn(0); 426071f87433Sdalcinl } 426171f87433Sdalcinl 426271f87433Sdalcinl #undef __FUNCT__ 4263fa9f3622SBarry Smith #define __FUNCT__ "SNESKSPSetParametersEW" 426471f87433Sdalcinl /*@ 4265fa9f3622SBarry Smith SNESKSPSetParametersEW - Sets parameters for Eisenstat-Walker 426671f87433Sdalcinl convergence criteria for the linear solvers within an inexact 426771f87433Sdalcinl Newton method. 426871f87433Sdalcinl 42693f9fe445SBarry Smith Logically Collective on SNES 427071f87433Sdalcinl 427171f87433Sdalcinl Input Parameters: 427271f87433Sdalcinl + snes - SNES context 427371f87433Sdalcinl . version - version 1, 2 (default is 2) or 3 427471f87433Sdalcinl . rtol_0 - initial relative tolerance (0 <= rtol_0 < 1) 427571f87433Sdalcinl . rtol_max - maximum relative tolerance (0 <= rtol_max < 1) 427671f87433Sdalcinl . gamma - multiplicative factor for version 2 rtol computation 427771f87433Sdalcinl (0 <= gamma2 <= 1) 427871f87433Sdalcinl . alpha - power for version 2 rtol computation (1 < alpha <= 2) 427971f87433Sdalcinl . alpha2 - power for safeguard 428071f87433Sdalcinl - threshold - threshold for imposing safeguard (0 < threshold < 1) 428171f87433Sdalcinl 428271f87433Sdalcinl Note: 428371f87433Sdalcinl Version 3 was contributed by Luis Chacon, June 2006. 428471f87433Sdalcinl 428571f87433Sdalcinl Use PETSC_DEFAULT to retain the default for any of the parameters. 428671f87433Sdalcinl 428771f87433Sdalcinl Level: advanced 428871f87433Sdalcinl 428971f87433Sdalcinl Reference: 429071f87433Sdalcinl S. C. Eisenstat and H. F. Walker, "Choosing the forcing terms in an 429171f87433Sdalcinl inexact Newton method", Utah State University Math. Stat. Dept. Res. 429271f87433Sdalcinl Report 6/94/75, June, 1994, to appear in SIAM J. Sci. Comput. 429371f87433Sdalcinl 429471f87433Sdalcinl .keywords: SNES, KSP, Eisenstat, Walker, set, parameters 429571f87433Sdalcinl 4296fa9f3622SBarry Smith .seealso: SNESKSPSetUseEW(), SNESKSPGetUseEW(), SNESKSPGetParametersEW() 429771f87433Sdalcinl @*/ 42987087cfbeSBarry Smith PetscErrorCode SNESKSPSetParametersEW(SNES snes,PetscInt version,PetscReal rtol_0,PetscReal rtol_max, 429971f87433Sdalcinl PetscReal gamma,PetscReal alpha,PetscReal alpha2,PetscReal threshold) 430071f87433Sdalcinl { 4301fa9f3622SBarry Smith SNESKSPEW *kctx; 430271f87433Sdalcinl PetscFunctionBegin; 43030700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 4304fa9f3622SBarry Smith kctx = (SNESKSPEW*)snes->kspconvctx; 4305e32f2f54SBarry Smith if (!kctx) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"No Eisenstat-Walker context existing"); 4306c5eb9154SBarry Smith PetscValidLogicalCollectiveInt(snes,version,2); 4307c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(snes,rtol_0,3); 4308c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(snes,rtol_max,4); 4309c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(snes,gamma,5); 4310c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(snes,alpha,6); 4311c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(snes,alpha2,7); 4312c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(snes,threshold,8); 431371f87433Sdalcinl 431471f87433Sdalcinl if (version != PETSC_DEFAULT) kctx->version = version; 431571f87433Sdalcinl if (rtol_0 != PETSC_DEFAULT) kctx->rtol_0 = rtol_0; 431671f87433Sdalcinl if (rtol_max != PETSC_DEFAULT) kctx->rtol_max = rtol_max; 431771f87433Sdalcinl if (gamma != PETSC_DEFAULT) kctx->gamma = gamma; 431871f87433Sdalcinl if (alpha != PETSC_DEFAULT) kctx->alpha = alpha; 431971f87433Sdalcinl if (alpha2 != PETSC_DEFAULT) kctx->alpha2 = alpha2; 432071f87433Sdalcinl if (threshold != PETSC_DEFAULT) kctx->threshold = threshold; 432171f87433Sdalcinl 432271f87433Sdalcinl if (kctx->version < 1 || kctx->version > 3) { 4323e32f2f54SBarry Smith SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Only versions 1, 2 and 3 are supported: %D",kctx->version); 432471f87433Sdalcinl } 432571f87433Sdalcinl if (kctx->rtol_0 < 0.0 || kctx->rtol_0 >= 1.0) { 4326e32f2f54SBarry Smith SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"0.0 <= rtol_0 < 1.0: %G",kctx->rtol_0); 432771f87433Sdalcinl } 432871f87433Sdalcinl if (kctx->rtol_max < 0.0 || kctx->rtol_max >= 1.0) { 4329e32f2f54SBarry Smith SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"0.0 <= rtol_max (%G) < 1.0\n",kctx->rtol_max); 433071f87433Sdalcinl } 433171f87433Sdalcinl if (kctx->gamma < 0.0 || kctx->gamma > 1.0) { 4332e32f2f54SBarry Smith SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"0.0 <= gamma (%G) <= 1.0\n",kctx->gamma); 433371f87433Sdalcinl } 433471f87433Sdalcinl if (kctx->alpha <= 1.0 || kctx->alpha > 2.0) { 4335e32f2f54SBarry Smith SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"1.0 < alpha (%G) <= 2.0\n",kctx->alpha); 433671f87433Sdalcinl } 433771f87433Sdalcinl if (kctx->threshold <= 0.0 || kctx->threshold >= 1.0) { 4338e32f2f54SBarry Smith SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"0.0 < threshold (%G) < 1.0\n",kctx->threshold); 433971f87433Sdalcinl } 434071f87433Sdalcinl PetscFunctionReturn(0); 434171f87433Sdalcinl } 434271f87433Sdalcinl 434371f87433Sdalcinl #undef __FUNCT__ 4344fa9f3622SBarry Smith #define __FUNCT__ "SNESKSPGetParametersEW" 434571f87433Sdalcinl /*@ 4346fa9f3622SBarry Smith SNESKSPGetParametersEW - Gets parameters for Eisenstat-Walker 434771f87433Sdalcinl convergence criteria for the linear solvers within an inexact 434871f87433Sdalcinl Newton method. 434971f87433Sdalcinl 435071f87433Sdalcinl Not Collective 435171f87433Sdalcinl 435271f87433Sdalcinl Input Parameters: 435371f87433Sdalcinl snes - SNES context 435471f87433Sdalcinl 435571f87433Sdalcinl Output Parameters: 435671f87433Sdalcinl + version - version 1, 2 (default is 2) or 3 435771f87433Sdalcinl . rtol_0 - initial relative tolerance (0 <= rtol_0 < 1) 435871f87433Sdalcinl . rtol_max - maximum relative tolerance (0 <= rtol_max < 1) 4359*bf388a1fSBarry Smith . gamma - multiplicative factor for version 2 rtol computation (0 <= gamma2 <= 1) 436071f87433Sdalcinl . alpha - power for version 2 rtol computation (1 < alpha <= 2) 436171f87433Sdalcinl . alpha2 - power for safeguard 436271f87433Sdalcinl - threshold - threshold for imposing safeguard (0 < threshold < 1) 436371f87433Sdalcinl 436471f87433Sdalcinl Level: advanced 436571f87433Sdalcinl 436671f87433Sdalcinl .keywords: SNES, KSP, Eisenstat, Walker, get, parameters 436771f87433Sdalcinl 4368fa9f3622SBarry Smith .seealso: SNESKSPSetUseEW(), SNESKSPGetUseEW(), SNESKSPSetParametersEW() 436971f87433Sdalcinl @*/ 4370*bf388a1fSBarry Smith PetscErrorCode SNESKSPGetParametersEW(SNES snes,PetscInt *version,PetscReal *rtol_0,PetscReal *rtol_max,PetscReal *gamma,PetscReal *alpha,PetscReal *alpha2,PetscReal *threshold) 437171f87433Sdalcinl { 4372fa9f3622SBarry Smith SNESKSPEW *kctx; 437371f87433Sdalcinl PetscFunctionBegin; 43740700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 4375fa9f3622SBarry Smith kctx = (SNESKSPEW*)snes->kspconvctx; 4376e32f2f54SBarry Smith if (!kctx) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"No Eisenstat-Walker context existing"); 437771f87433Sdalcinl if (version) *version = kctx->version; 437871f87433Sdalcinl if (rtol_0) *rtol_0 = kctx->rtol_0; 437971f87433Sdalcinl if (rtol_max) *rtol_max = kctx->rtol_max; 438071f87433Sdalcinl if (gamma) *gamma = kctx->gamma; 438171f87433Sdalcinl if (alpha) *alpha = kctx->alpha; 438271f87433Sdalcinl if (alpha2) *alpha2 = kctx->alpha2; 438371f87433Sdalcinl if (threshold) *threshold = kctx->threshold; 438471f87433Sdalcinl PetscFunctionReturn(0); 438571f87433Sdalcinl } 438671f87433Sdalcinl 438771f87433Sdalcinl #undef __FUNCT__ 4388fa9f3622SBarry Smith #define __FUNCT__ "SNESKSPEW_PreSolve" 4389fa9f3622SBarry Smith static PetscErrorCode SNESKSPEW_PreSolve(SNES snes, KSP ksp, Vec b, Vec x) 439071f87433Sdalcinl { 439171f87433Sdalcinl PetscErrorCode ierr; 4392fa9f3622SBarry Smith SNESKSPEW *kctx = (SNESKSPEW*)snes->kspconvctx; 439371f87433Sdalcinl PetscReal rtol=PETSC_DEFAULT,stol; 439471f87433Sdalcinl 439571f87433Sdalcinl PetscFunctionBegin; 4396e32f2f54SBarry Smith if (!kctx) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"No Eisenstat-Walker context exists"); 439771f87433Sdalcinl if (!snes->iter) { /* first time in, so use the original user rtol */ 439871f87433Sdalcinl rtol = kctx->rtol_0; 439971f87433Sdalcinl } else { 440071f87433Sdalcinl if (kctx->version == 1) { 440171f87433Sdalcinl rtol = (snes->norm - kctx->lresid_last)/kctx->norm_last; 440271f87433Sdalcinl if (rtol < 0.0) rtol = -rtol; 440371f87433Sdalcinl stol = pow(kctx->rtol_last,kctx->alpha2); 440471f87433Sdalcinl if (stol > kctx->threshold) rtol = PetscMax(rtol,stol); 440571f87433Sdalcinl } else if (kctx->version == 2) { 440671f87433Sdalcinl rtol = kctx->gamma * pow(snes->norm/kctx->norm_last,kctx->alpha); 440771f87433Sdalcinl stol = kctx->gamma * pow(kctx->rtol_last,kctx->alpha); 440871f87433Sdalcinl if (stol > kctx->threshold) rtol = PetscMax(rtol,stol); 440971f87433Sdalcinl } else if (kctx->version == 3) {/* contributed by Luis Chacon, June 2006. */ 441071f87433Sdalcinl rtol = kctx->gamma * pow(snes->norm/kctx->norm_last,kctx->alpha); 441171f87433Sdalcinl /* safeguard: avoid sharp decrease of rtol */ 441271f87433Sdalcinl stol = kctx->gamma*pow(kctx->rtol_last,kctx->alpha); 441371f87433Sdalcinl stol = PetscMax(rtol,stol); 441471f87433Sdalcinl rtol = PetscMin(kctx->rtol_0,stol); 441571f87433Sdalcinl /* safeguard: avoid oversolving */ 441671f87433Sdalcinl stol = kctx->gamma*(snes->ttol)/snes->norm; 441771f87433Sdalcinl stol = PetscMax(rtol,stol); 441871f87433Sdalcinl rtol = PetscMin(kctx->rtol_0,stol); 4419e32f2f54SBarry Smith } else SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Only versions 1, 2 or 3 are supported: %D",kctx->version); 442071f87433Sdalcinl } 442171f87433Sdalcinl /* safeguard: avoid rtol greater than one */ 442271f87433Sdalcinl rtol = PetscMin(rtol,kctx->rtol_max); 442371f87433Sdalcinl ierr = KSPSetTolerances(ksp,rtol,PETSC_DEFAULT,PETSC_DEFAULT,PETSC_DEFAULT);CHKERRQ(ierr); 442471f87433Sdalcinl ierr = PetscInfo3(snes,"iter %D, Eisenstat-Walker (version %D) KSP rtol=%G\n",snes->iter,kctx->version,rtol);CHKERRQ(ierr); 442571f87433Sdalcinl PetscFunctionReturn(0); 442671f87433Sdalcinl } 442771f87433Sdalcinl 442871f87433Sdalcinl #undef __FUNCT__ 4429fa9f3622SBarry Smith #define __FUNCT__ "SNESKSPEW_PostSolve" 4430fa9f3622SBarry Smith static PetscErrorCode SNESKSPEW_PostSolve(SNES snes, KSP ksp, Vec b, Vec x) 443171f87433Sdalcinl { 443271f87433Sdalcinl PetscErrorCode ierr; 4433fa9f3622SBarry Smith SNESKSPEW *kctx = (SNESKSPEW*)snes->kspconvctx; 443471f87433Sdalcinl PCSide pcside; 443571f87433Sdalcinl Vec lres; 443671f87433Sdalcinl 443771f87433Sdalcinl PetscFunctionBegin; 4438e32f2f54SBarry Smith if (!kctx) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"No Eisenstat-Walker context exists"); 443971f87433Sdalcinl ierr = KSPGetTolerances(ksp,&kctx->rtol_last,0,0,0);CHKERRQ(ierr); 444071f87433Sdalcinl ierr = SNESGetFunctionNorm(snes,&kctx->norm_last);CHKERRQ(ierr); 444171f87433Sdalcinl if (kctx->version == 1) { 4442b037da10SBarry Smith ierr = KSPGetPCSide(ksp,&pcside);CHKERRQ(ierr); 444371f87433Sdalcinl if (pcside == PC_RIGHT) { /* XXX Should we also test KSP_UNPRECONDITIONED_NORM ? */ 444471f87433Sdalcinl /* KSP residual is true linear residual */ 444571f87433Sdalcinl ierr = KSPGetResidualNorm(ksp,&kctx->lresid_last);CHKERRQ(ierr); 444671f87433Sdalcinl } else { 444771f87433Sdalcinl /* KSP residual is preconditioned residual */ 444871f87433Sdalcinl /* compute true linear residual norm */ 444971f87433Sdalcinl ierr = VecDuplicate(b,&lres);CHKERRQ(ierr); 445071f87433Sdalcinl ierr = MatMult(snes->jacobian,x,lres);CHKERRQ(ierr); 445171f87433Sdalcinl ierr = VecAYPX(lres,-1.0,b);CHKERRQ(ierr); 445271f87433Sdalcinl ierr = VecNorm(lres,NORM_2,&kctx->lresid_last);CHKERRQ(ierr); 44536bf464f9SBarry Smith ierr = VecDestroy(&lres);CHKERRQ(ierr); 445471f87433Sdalcinl } 445571f87433Sdalcinl } 445671f87433Sdalcinl PetscFunctionReturn(0); 445771f87433Sdalcinl } 445871f87433Sdalcinl 445971f87433Sdalcinl #undef __FUNCT__ 446071f87433Sdalcinl #define __FUNCT__ "SNES_KSPSolve" 446171f87433Sdalcinl PetscErrorCode SNES_KSPSolve(SNES snes, KSP ksp, Vec b, Vec x) 446271f87433Sdalcinl { 446371f87433Sdalcinl PetscErrorCode ierr; 446471f87433Sdalcinl 446571f87433Sdalcinl PetscFunctionBegin; 4466fa9f3622SBarry Smith if (snes->ksp_ewconv) { ierr = SNESKSPEW_PreSolve(snes,ksp,b,x);CHKERRQ(ierr); } 446771f87433Sdalcinl ierr = KSPSolve(ksp,b,x);CHKERRQ(ierr); 4468fa9f3622SBarry Smith if (snes->ksp_ewconv) { ierr = SNESKSPEW_PostSolve(snes,ksp,b,x);CHKERRQ(ierr); } 446971f87433Sdalcinl PetscFunctionReturn(0); 447071f87433Sdalcinl } 44716c699258SBarry Smith 4472b4615a05SBarry Smith #include <petsc-private/dmimpl.h> 44736c699258SBarry Smith #undef __FUNCT__ 44746c699258SBarry Smith #define __FUNCT__ "SNESSetDM" 44756c699258SBarry Smith /*@ 44766c699258SBarry Smith SNESSetDM - Sets the DM that may be used by some preconditioners 44776c699258SBarry Smith 44783f9fe445SBarry Smith Logically Collective on SNES 44796c699258SBarry Smith 44806c699258SBarry Smith Input Parameters: 44816c699258SBarry Smith + snes - the preconditioner context 44826c699258SBarry Smith - dm - the dm 44836c699258SBarry Smith 44846c699258SBarry Smith Level: intermediate 44856c699258SBarry Smith 44866c699258SBarry Smith .seealso: SNESGetDM(), KSPSetDM(), KSPGetDM() 44876c699258SBarry Smith @*/ 44887087cfbeSBarry Smith PetscErrorCode SNESSetDM(SNES snes,DM dm) 44896c699258SBarry Smith { 44906c699258SBarry Smith PetscErrorCode ierr; 4491345fed2cSBarry Smith KSP ksp; 4492942e3340SBarry Smith DMSNES sdm; 44936c699258SBarry Smith 44946c699258SBarry Smith PetscFunctionBegin; 44950700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 4496d0660788SBarry Smith if (dm) {ierr = PetscObjectReference((PetscObject)dm);CHKERRQ(ierr);} 4497942e3340SBarry Smith if (snes->dm) { /* Move the DMSNES context over to the new DM unless the new DM already has one */ 4498b4615a05SBarry Smith if (snes->dm->dmsnes && snes->dmAuto && !dm->dmsnes) { 4499942e3340SBarry Smith ierr = DMCopyDMSNES(snes->dm,dm);CHKERRQ(ierr); 4500942e3340SBarry Smith ierr = DMGetDMSNES(snes->dm,&sdm);CHKERRQ(ierr); 45016cab3a1bSJed Brown if (sdm->originaldm == snes->dm) { /* Grant write privileges to the replacement DM */ 45026cab3a1bSJed Brown sdm->originaldm = dm; 45036cab3a1bSJed Brown } 45046cab3a1bSJed Brown } 45056bf464f9SBarry Smith ierr = DMDestroy(&snes->dm);CHKERRQ(ierr); 45066cab3a1bSJed Brown } 45076c699258SBarry Smith snes->dm = dm; 4508116d1032SJed Brown snes->dmAuto = PETSC_FALSE; 4509345fed2cSBarry Smith ierr = SNESGetKSP(snes,&ksp);CHKERRQ(ierr); 4510345fed2cSBarry Smith ierr = KSPSetDM(ksp,dm);CHKERRQ(ierr); 4511f22f69f0SBarry Smith ierr = KSPSetDMActive(ksp,PETSC_FALSE);CHKERRQ(ierr); 45122c155ee1SBarry Smith if (snes->pc) { 45132c155ee1SBarry Smith ierr = SNESSetDM(snes->pc, snes->dm);CHKERRQ(ierr); 4514c40d0f55SPeter Brune ierr = SNESSetPCSide(snes,snes->pcside);CHKERRQ(ierr); 45152c155ee1SBarry Smith } 45166c699258SBarry Smith PetscFunctionReturn(0); 45176c699258SBarry Smith } 45186c699258SBarry Smith 45196c699258SBarry Smith #undef __FUNCT__ 45206c699258SBarry Smith #define __FUNCT__ "SNESGetDM" 45216c699258SBarry Smith /*@ 45226c699258SBarry Smith SNESGetDM - Gets the DM that may be used by some preconditioners 45236c699258SBarry Smith 45243f9fe445SBarry Smith Not Collective but DM obtained is parallel on SNES 45256c699258SBarry Smith 45266c699258SBarry Smith Input Parameter: 45276c699258SBarry Smith . snes - the preconditioner context 45286c699258SBarry Smith 45296c699258SBarry Smith Output Parameter: 45306c699258SBarry Smith . dm - the dm 45316c699258SBarry Smith 45326c699258SBarry Smith Level: intermediate 45336c699258SBarry Smith 45346c699258SBarry Smith .seealso: SNESSetDM(), KSPSetDM(), KSPGetDM() 45356c699258SBarry Smith @*/ 45367087cfbeSBarry Smith PetscErrorCode SNESGetDM(SNES snes,DM *dm) 45376c699258SBarry Smith { 45386cab3a1bSJed Brown PetscErrorCode ierr; 45396cab3a1bSJed Brown 45406c699258SBarry Smith PetscFunctionBegin; 45410700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 45426cab3a1bSJed Brown if (!snes->dm) { 45436cab3a1bSJed Brown ierr = DMShellCreate(((PetscObject)snes)->comm,&snes->dm);CHKERRQ(ierr); 4544116d1032SJed Brown snes->dmAuto = PETSC_TRUE; 45456cab3a1bSJed Brown } 45466c699258SBarry Smith *dm = snes->dm; 45476c699258SBarry Smith PetscFunctionReturn(0); 45486c699258SBarry Smith } 45490807856dSBarry Smith 455031823bd8SMatthew G Knepley #undef __FUNCT__ 455131823bd8SMatthew G Knepley #define __FUNCT__ "SNESSetPC" 455231823bd8SMatthew G Knepley /*@ 4553fd4b34e9SJed Brown SNESSetPC - Sets the nonlinear preconditioner to be used. 455431823bd8SMatthew G Knepley 455531823bd8SMatthew G Knepley Collective on SNES 455631823bd8SMatthew G Knepley 455731823bd8SMatthew G Knepley Input Parameters: 455831823bd8SMatthew G Knepley + snes - iterative context obtained from SNESCreate() 455931823bd8SMatthew G Knepley - pc - the preconditioner object 456031823bd8SMatthew G Knepley 456131823bd8SMatthew G Knepley Notes: 456231823bd8SMatthew G Knepley Use SNESGetPC() to retrieve the preconditioner context (for example, 456331823bd8SMatthew G Knepley to configure it using the API). 456431823bd8SMatthew G Knepley 456531823bd8SMatthew G Knepley Level: developer 456631823bd8SMatthew G Knepley 456731823bd8SMatthew G Knepley .keywords: SNES, set, precondition 456831823bd8SMatthew G Knepley .seealso: SNESGetPC() 456931823bd8SMatthew G Knepley @*/ 457031823bd8SMatthew G Knepley PetscErrorCode SNESSetPC(SNES snes, SNES pc) 457131823bd8SMatthew G Knepley { 457231823bd8SMatthew G Knepley PetscErrorCode ierr; 457331823bd8SMatthew G Knepley 457431823bd8SMatthew G Knepley PetscFunctionBegin; 457531823bd8SMatthew G Knepley PetscValidHeaderSpecific(snes, SNES_CLASSID, 1); 457631823bd8SMatthew G Knepley PetscValidHeaderSpecific(pc, SNES_CLASSID, 2); 457731823bd8SMatthew G Knepley PetscCheckSameComm(snes, 1, pc, 2); 457831823bd8SMatthew G Knepley ierr = PetscObjectReference((PetscObject) pc);CHKERRQ(ierr); 4579bf11d3b6SBarry Smith ierr = SNESDestroy(&snes->pc);CHKERRQ(ierr); 458031823bd8SMatthew G Knepley snes->pc = pc; 458131823bd8SMatthew G Knepley ierr = PetscLogObjectParent(snes, snes->pc);CHKERRQ(ierr); 458231823bd8SMatthew G Knepley PetscFunctionReturn(0); 458331823bd8SMatthew G Knepley } 458431823bd8SMatthew G Knepley 458531823bd8SMatthew G Knepley #undef __FUNCT__ 458631823bd8SMatthew G Knepley #define __FUNCT__ "SNESGetPC" 458731823bd8SMatthew G Knepley /*@ 4588fd4b34e9SJed Brown SNESGetPC - Returns a pointer to the nonlinear preconditioning context set with SNESSetPC(). 458931823bd8SMatthew G Knepley 459031823bd8SMatthew G Knepley Not Collective 459131823bd8SMatthew G Knepley 459231823bd8SMatthew G Knepley Input Parameter: 459331823bd8SMatthew G Knepley . snes - iterative context obtained from SNESCreate() 459431823bd8SMatthew G Knepley 459531823bd8SMatthew G Knepley Output Parameter: 459631823bd8SMatthew G Knepley . pc - preconditioner context 459731823bd8SMatthew G Knepley 459831823bd8SMatthew G Knepley Level: developer 459931823bd8SMatthew G Knepley 460031823bd8SMatthew G Knepley .keywords: SNES, get, preconditioner 460131823bd8SMatthew G Knepley .seealso: SNESSetPC() 460231823bd8SMatthew G Knepley @*/ 460331823bd8SMatthew G Knepley PetscErrorCode SNESGetPC(SNES snes, SNES *pc) 460431823bd8SMatthew G Knepley { 460531823bd8SMatthew G Knepley PetscErrorCode ierr; 4606a64e098fSPeter Brune const char *optionsprefix; 460731823bd8SMatthew G Knepley 460831823bd8SMatthew G Knepley PetscFunctionBegin; 460931823bd8SMatthew G Knepley PetscValidHeaderSpecific(snes, SNES_CLASSID, 1); 461031823bd8SMatthew G Knepley PetscValidPointer(pc, 2); 461131823bd8SMatthew G Knepley if (!snes->pc) { 461231823bd8SMatthew G Knepley ierr = SNESCreate(((PetscObject) snes)->comm,&snes->pc);CHKERRQ(ierr); 46134a0c5b0cSMatthew G Knepley ierr = PetscObjectIncrementTabLevel((PetscObject)snes->pc,(PetscObject)snes,1);CHKERRQ(ierr); 461431823bd8SMatthew G Knepley ierr = PetscLogObjectParent(snes,snes->pc);CHKERRQ(ierr); 4615a64e098fSPeter Brune ierr = SNESGetOptionsPrefix(snes,&optionsprefix);CHKERRQ(ierr); 4616a64e098fSPeter Brune ierr = SNESSetOptionsPrefix(snes->pc,optionsprefix);CHKERRQ(ierr); 4617a64e098fSPeter Brune ierr = SNESAppendOptionsPrefix(snes->pc,"npc_");CHKERRQ(ierr); 461831823bd8SMatthew G Knepley } 461931823bd8SMatthew G Knepley *pc = snes->pc; 462031823bd8SMatthew G Knepley PetscFunctionReturn(0); 462131823bd8SMatthew G Knepley } 462231823bd8SMatthew G Knepley 4623c40d0f55SPeter Brune #undef __FUNCT__ 4624c40d0f55SPeter Brune #define __FUNCT__ "SNESSetPCSide" 4625c40d0f55SPeter Brune /*@ 4626c40d0f55SPeter Brune SNESSetPCSide - Sets the preconditioning side. 4627c40d0f55SPeter Brune 4628c40d0f55SPeter Brune Logically Collective on SNES 4629c40d0f55SPeter Brune 4630c40d0f55SPeter Brune Input Parameter: 4631c40d0f55SPeter Brune . snes - iterative context obtained from SNESCreate() 4632c40d0f55SPeter Brune 4633c40d0f55SPeter Brune Output Parameter: 4634c40d0f55SPeter Brune . side - the preconditioning side, where side is one of 4635c40d0f55SPeter Brune .vb 4636c40d0f55SPeter Brune PC_LEFT - left preconditioning (default) 4637c40d0f55SPeter Brune PC_RIGHT - right preconditioning 4638c40d0f55SPeter Brune .ve 4639c40d0f55SPeter Brune 4640c40d0f55SPeter Brune Options Database Keys: 4641c40d0f55SPeter Brune . -snes_pc_side <right,left> 4642c40d0f55SPeter Brune 4643c40d0f55SPeter Brune Level: intermediate 4644c40d0f55SPeter Brune 4645c40d0f55SPeter Brune .keywords: SNES, set, right, left, side, preconditioner, flag 4646c40d0f55SPeter Brune 4647c40d0f55SPeter Brune .seealso: SNESGetPCSide(), KSPSetPCSide() 4648c40d0f55SPeter Brune @*/ 4649c40d0f55SPeter Brune PetscErrorCode SNESSetPCSide(SNES snes,PCSide side) 4650c40d0f55SPeter Brune { 4651c40d0f55SPeter Brune PetscFunctionBegin; 4652c40d0f55SPeter Brune PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 4653c40d0f55SPeter Brune PetscValidLogicalCollectiveEnum(snes,side,2); 4654c40d0f55SPeter Brune snes->pcside = side; 4655c40d0f55SPeter Brune PetscFunctionReturn(0); 4656c40d0f55SPeter Brune } 4657c40d0f55SPeter Brune 4658c40d0f55SPeter Brune #undef __FUNCT__ 4659c40d0f55SPeter Brune #define __FUNCT__ "SNESGetPCSide" 4660c40d0f55SPeter Brune /*@ 4661c40d0f55SPeter Brune SNESGetPCSide - Gets the preconditioning side. 4662c40d0f55SPeter Brune 4663c40d0f55SPeter Brune Not Collective 4664c40d0f55SPeter Brune 4665c40d0f55SPeter Brune Input Parameter: 4666c40d0f55SPeter Brune . snes - iterative context obtained from SNESCreate() 4667c40d0f55SPeter Brune 4668c40d0f55SPeter Brune Output Parameter: 4669c40d0f55SPeter Brune . side - the preconditioning side, where side is one of 4670c40d0f55SPeter Brune .vb 4671c40d0f55SPeter Brune PC_LEFT - left preconditioning (default) 4672c40d0f55SPeter Brune PC_RIGHT - right preconditioning 4673c40d0f55SPeter Brune .ve 4674c40d0f55SPeter Brune 4675c40d0f55SPeter Brune Level: intermediate 4676c40d0f55SPeter Brune 4677c40d0f55SPeter Brune .keywords: SNES, get, right, left, side, preconditioner, flag 4678c40d0f55SPeter Brune 4679c40d0f55SPeter Brune .seealso: SNESSetPCSide(), KSPGetPCSide() 4680c40d0f55SPeter Brune @*/ 4681c40d0f55SPeter Brune PetscErrorCode SNESGetPCSide(SNES snes,PCSide *side) 4682c40d0f55SPeter Brune { 4683c40d0f55SPeter Brune PetscFunctionBegin; 4684c40d0f55SPeter Brune PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 4685c40d0f55SPeter Brune PetscValidPointer(side,2); 4686c40d0f55SPeter Brune *side = snes->pcside; 4687c40d0f55SPeter Brune PetscFunctionReturn(0); 4688c40d0f55SPeter Brune } 4689c40d0f55SPeter Brune 46909e764e56SPeter Brune #undef __FUNCT__ 4691f1c6b773SPeter Brune #define __FUNCT__ "SNESSetSNESLineSearch" 46929e764e56SPeter Brune /*@ 46938141a3b9SPeter Brune SNESSetSNESLineSearch - Sets the linesearch on the SNES instance. 46949e764e56SPeter Brune 46959e764e56SPeter Brune Collective on SNES 46969e764e56SPeter Brune 46979e764e56SPeter Brune Input Parameters: 46989e764e56SPeter Brune + snes - iterative context obtained from SNESCreate() 46999e764e56SPeter Brune - linesearch - the linesearch object 47009e764e56SPeter Brune 47019e764e56SPeter Brune Notes: 4702f1c6b773SPeter Brune Use SNESGetSNESLineSearch() to retrieve the preconditioner context (for example, 47039e764e56SPeter Brune to configure it using the API). 47049e764e56SPeter Brune 47059e764e56SPeter Brune Level: developer 47069e764e56SPeter Brune 47079e764e56SPeter Brune .keywords: SNES, set, linesearch 4708f1c6b773SPeter Brune .seealso: SNESGetSNESLineSearch() 47099e764e56SPeter Brune @*/ 4710f1c6b773SPeter Brune PetscErrorCode SNESSetSNESLineSearch(SNES snes, SNESLineSearch linesearch) 47119e764e56SPeter Brune { 47129e764e56SPeter Brune PetscErrorCode ierr; 47139e764e56SPeter Brune 47149e764e56SPeter Brune PetscFunctionBegin; 47159e764e56SPeter Brune PetscValidHeaderSpecific(snes, SNES_CLASSID, 1); 4716f1c6b773SPeter Brune PetscValidHeaderSpecific(linesearch, SNESLINESEARCH_CLASSID, 2); 47179e764e56SPeter Brune PetscCheckSameComm(snes, 1, linesearch, 2); 47189e764e56SPeter Brune ierr = PetscObjectReference((PetscObject) linesearch);CHKERRQ(ierr); 4719f1c6b773SPeter Brune ierr = SNESLineSearchDestroy(&snes->linesearch);CHKERRQ(ierr); 47209e764e56SPeter Brune snes->linesearch = linesearch; 47219e764e56SPeter Brune ierr = PetscLogObjectParent(snes, snes->linesearch);CHKERRQ(ierr); 47229e764e56SPeter Brune PetscFunctionReturn(0); 47239e764e56SPeter Brune } 47249e764e56SPeter Brune 47259e764e56SPeter Brune #undef __FUNCT__ 4726f1c6b773SPeter Brune #define __FUNCT__ "SNESGetSNESLineSearch" 4727ea5d4fccSPeter Brune /*@C 47288141a3b9SPeter Brune SNESGetSNESLineSearch - Returns a pointer to the line search context set with SNESSetLineSearch() 47298141a3b9SPeter Brune or creates a default line search instance associated with the SNES and returns it. 47309e764e56SPeter Brune 47319e764e56SPeter Brune Not Collective 47329e764e56SPeter Brune 47339e764e56SPeter Brune Input Parameter: 47349e764e56SPeter Brune . snes - iterative context obtained from SNESCreate() 47359e764e56SPeter Brune 47369e764e56SPeter Brune Output Parameter: 47379e764e56SPeter Brune . linesearch - linesearch context 47389e764e56SPeter Brune 47399e764e56SPeter Brune Level: developer 47409e764e56SPeter Brune 47419e764e56SPeter Brune .keywords: SNES, get, linesearch 4742f1c6b773SPeter Brune .seealso: SNESSetSNESLineSearch() 47439e764e56SPeter Brune @*/ 4744f1c6b773SPeter Brune PetscErrorCode SNESGetSNESLineSearch(SNES snes, SNESLineSearch *linesearch) 47459e764e56SPeter Brune { 47469e764e56SPeter Brune PetscErrorCode ierr; 47479e764e56SPeter Brune const char *optionsprefix; 47489e764e56SPeter Brune 47499e764e56SPeter Brune PetscFunctionBegin; 47509e764e56SPeter Brune PetscValidHeaderSpecific(snes, SNES_CLASSID, 1); 47519e764e56SPeter Brune PetscValidPointer(linesearch, 2); 47529e764e56SPeter Brune if (!snes->linesearch) { 47539e764e56SPeter Brune ierr = SNESGetOptionsPrefix(snes, &optionsprefix);CHKERRQ(ierr); 4754f1c6b773SPeter Brune ierr = SNESLineSearchCreate(((PetscObject) snes)->comm, &snes->linesearch);CHKERRQ(ierr); 4755f1c6b773SPeter Brune ierr = SNESLineSearchSetSNES(snes->linesearch, snes);CHKERRQ(ierr); 4756b1dca40bSPeter Brune ierr = SNESLineSearchAppendOptionsPrefix(snes->linesearch, optionsprefix);CHKERRQ(ierr); 47579e764e56SPeter Brune ierr = PetscObjectIncrementTabLevel((PetscObject) snes->linesearch, (PetscObject) snes, 1);CHKERRQ(ierr); 47589e764e56SPeter Brune ierr = PetscLogObjectParent(snes, snes->linesearch);CHKERRQ(ierr); 47599e764e56SPeter Brune } 47609e764e56SPeter Brune *linesearch = snes->linesearch; 47619e764e56SPeter Brune PetscFunctionReturn(0); 47629e764e56SPeter Brune } 47639e764e56SPeter Brune 476469b4f73cSBarry Smith #if defined(PETSC_HAVE_MATLAB_ENGINE) 4765c6db04a5SJed Brown #include <mex.h> 476669b4f73cSBarry Smith 47678f6e6473SBarry Smith typedef struct {char *funcname; mxArray *ctx;} SNESMatlabContext; 47688f6e6473SBarry Smith 47690807856dSBarry Smith #undef __FUNCT__ 47700807856dSBarry Smith #define __FUNCT__ "SNESComputeFunction_Matlab" 47710807856dSBarry Smith /* 4772*bf388a1fSBarry Smith SNESComputeFunction_Matlab - Calls the function that has been set with SNESSetFunctionMatlab(). 47730807856dSBarry Smith 47740807856dSBarry Smith Collective on SNES 47750807856dSBarry Smith 47760807856dSBarry Smith Input Parameters: 47770807856dSBarry Smith + snes - the SNES context 47780807856dSBarry Smith - x - input vector 47790807856dSBarry Smith 47800807856dSBarry Smith Output Parameter: 47810807856dSBarry Smith . y - function vector, as set by SNESSetFunction() 47820807856dSBarry Smith 47830807856dSBarry Smith Notes: 47840807856dSBarry Smith SNESComputeFunction() is typically used within nonlinear solvers 47850807856dSBarry Smith implementations, so most users would not generally call this routine 47860807856dSBarry Smith themselves. 47870807856dSBarry Smith 47880807856dSBarry Smith Level: developer 47890807856dSBarry Smith 47900807856dSBarry Smith .keywords: SNES, nonlinear, compute, function 47910807856dSBarry Smith 47920807856dSBarry Smith .seealso: SNESSetFunction(), SNESGetFunction() 479361b2408cSBarry Smith */ 47947087cfbeSBarry Smith PetscErrorCode SNESComputeFunction_Matlab(SNES snes,Vec x,Vec y, void *ctx) 47950807856dSBarry Smith { 4796e650e774SBarry Smith PetscErrorCode ierr; 47978f6e6473SBarry Smith SNESMatlabContext *sctx = (SNESMatlabContext *)ctx; 47988f6e6473SBarry Smith int nlhs = 1,nrhs = 5; 47998f6e6473SBarry Smith mxArray *plhs[1],*prhs[5]; 480091621f2eSBarry Smith long long int lx = 0,ly = 0,ls = 0; 4801e650e774SBarry Smith 48020807856dSBarry Smith PetscFunctionBegin; 48030807856dSBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 48040807856dSBarry Smith PetscValidHeaderSpecific(x,VEC_CLASSID,2); 48050807856dSBarry Smith PetscValidHeaderSpecific(y,VEC_CLASSID,3); 48060807856dSBarry Smith PetscCheckSameComm(snes,1,x,2); 48070807856dSBarry Smith PetscCheckSameComm(snes,1,y,3); 48080807856dSBarry Smith 48090807856dSBarry Smith /* call Matlab function in ctx with arguments x and y */ 4810e650e774SBarry Smith 481191621f2eSBarry Smith ierr = PetscMemcpy(&ls,&snes,sizeof(snes));CHKERRQ(ierr); 4812e650e774SBarry Smith ierr = PetscMemcpy(&lx,&x,sizeof(x));CHKERRQ(ierr); 4813e650e774SBarry Smith ierr = PetscMemcpy(&ly,&y,sizeof(x));CHKERRQ(ierr); 481491621f2eSBarry Smith prhs[0] = mxCreateDoubleScalar((double)ls); 481591621f2eSBarry Smith prhs[1] = mxCreateDoubleScalar((double)lx); 481691621f2eSBarry Smith prhs[2] = mxCreateDoubleScalar((double)ly); 48178f6e6473SBarry Smith prhs[3] = mxCreateString(sctx->funcname); 48188f6e6473SBarry Smith prhs[4] = sctx->ctx; 4819b807a863SBarry Smith ierr = mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscSNESComputeFunctionInternal");CHKERRQ(ierr); 4820e650e774SBarry Smith ierr = mxGetScalar(plhs[0]);CHKERRQ(ierr); 4821e650e774SBarry Smith mxDestroyArray(prhs[0]); 4822e650e774SBarry Smith mxDestroyArray(prhs[1]); 4823e650e774SBarry Smith mxDestroyArray(prhs[2]); 48248f6e6473SBarry Smith mxDestroyArray(prhs[3]); 4825e650e774SBarry Smith mxDestroyArray(plhs[0]); 48260807856dSBarry Smith PetscFunctionReturn(0); 48270807856dSBarry Smith } 48280807856dSBarry Smith 48290807856dSBarry Smith #undef __FUNCT__ 48300807856dSBarry Smith #define __FUNCT__ "SNESSetFunctionMatlab" 483161b2408cSBarry Smith /* 48320807856dSBarry Smith SNESSetFunctionMatlab - Sets the function evaluation routine and function 48330807856dSBarry Smith vector for use by the SNES routines in solving systems of nonlinear 4834e3c5b3baSBarry Smith equations from MATLAB. Here the function is a string containing the name of a MATLAB function 48350807856dSBarry Smith 48360807856dSBarry Smith Logically Collective on SNES 48370807856dSBarry Smith 48380807856dSBarry Smith Input Parameters: 48390807856dSBarry Smith + snes - the SNES context 48400807856dSBarry Smith . r - vector to store function value 4841*bf388a1fSBarry Smith - SNESFunction - function evaluation routine 48420807856dSBarry Smith 48430807856dSBarry Smith Notes: 48440807856dSBarry Smith The Newton-like methods typically solve linear systems of the form 48450807856dSBarry Smith $ f'(x) x = -f(x), 48460807856dSBarry Smith where f'(x) denotes the Jacobian matrix and f(x) is the function. 48470807856dSBarry Smith 48480807856dSBarry Smith Level: beginner 48490807856dSBarry Smith 48500807856dSBarry Smith .keywords: SNES, nonlinear, set, function 48510807856dSBarry Smith 48520807856dSBarry Smith .seealso: SNESGetFunction(), SNESComputeFunction(), SNESSetJacobian(), SNESSetFunction() 485361b2408cSBarry Smith */ 4854*bf388a1fSBarry Smith PetscErrorCode SNESSetFunctionMatlab(SNES snes,Vec r,const char *SNESFunction,mxArray *ctx) 48550807856dSBarry Smith { 48560807856dSBarry Smith PetscErrorCode ierr; 48578f6e6473SBarry Smith SNESMatlabContext *sctx; 48580807856dSBarry Smith 48590807856dSBarry Smith PetscFunctionBegin; 48608f6e6473SBarry Smith /* currently sctx is memory bleed */ 48618f6e6473SBarry Smith ierr = PetscMalloc(sizeof(SNESMatlabContext),&sctx);CHKERRQ(ierr); 4862*bf388a1fSBarry Smith ierr = PetscStrallocpy(SNESFunction,&sctx->funcname);CHKERRQ(ierr); 48638f6e6473SBarry Smith /* 48648f6e6473SBarry Smith This should work, but it doesn't 48658f6e6473SBarry Smith sctx->ctx = ctx; 48668f6e6473SBarry Smith mexMakeArrayPersistent(sctx->ctx); 48678f6e6473SBarry Smith */ 48688f6e6473SBarry Smith sctx->ctx = mxDuplicateArray(ctx); 48698f6e6473SBarry Smith ierr = SNESSetFunction(snes,r,SNESComputeFunction_Matlab,sctx);CHKERRQ(ierr); 48700807856dSBarry Smith PetscFunctionReturn(0); 48710807856dSBarry Smith } 487269b4f73cSBarry Smith 487361b2408cSBarry Smith #undef __FUNCT__ 487461b2408cSBarry Smith #define __FUNCT__ "SNESComputeJacobian_Matlab" 487561b2408cSBarry Smith /* 4876*bf388a1fSBarry Smith SNESComputeJacobian_Matlab - Calls the function that has been set with SNESSetJacobianMatlab(). 487761b2408cSBarry Smith 487861b2408cSBarry Smith Collective on SNES 487961b2408cSBarry Smith 488061b2408cSBarry Smith Input Parameters: 488161b2408cSBarry Smith + snes - the SNES context 488261b2408cSBarry Smith . x - input vector 488361b2408cSBarry Smith . A, B - the matrices 488461b2408cSBarry Smith - ctx - user context 488561b2408cSBarry Smith 488661b2408cSBarry Smith Output Parameter: 488761b2408cSBarry Smith . flag - structure of the matrix 488861b2408cSBarry Smith 488961b2408cSBarry Smith Level: developer 489061b2408cSBarry Smith 489161b2408cSBarry Smith .keywords: SNES, nonlinear, compute, function 489261b2408cSBarry Smith 489361b2408cSBarry Smith .seealso: SNESSetFunction(), SNESGetFunction() 489461b2408cSBarry Smith @*/ 48957087cfbeSBarry Smith PetscErrorCode SNESComputeJacobian_Matlab(SNES snes,Vec x,Mat *A,Mat *B,MatStructure *flag, void *ctx) 489661b2408cSBarry Smith { 489761b2408cSBarry Smith PetscErrorCode ierr; 489861b2408cSBarry Smith SNESMatlabContext *sctx = (SNESMatlabContext *)ctx; 489961b2408cSBarry Smith int nlhs = 2,nrhs = 6; 490061b2408cSBarry Smith mxArray *plhs[2],*prhs[6]; 490161b2408cSBarry Smith long long int lx = 0,lA = 0,ls = 0, lB = 0; 490261b2408cSBarry Smith 490361b2408cSBarry Smith PetscFunctionBegin; 490461b2408cSBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 490561b2408cSBarry Smith PetscValidHeaderSpecific(x,VEC_CLASSID,2); 490661b2408cSBarry Smith 490761b2408cSBarry Smith /* call Matlab function in ctx with arguments x and y */ 490861b2408cSBarry Smith 490961b2408cSBarry Smith ierr = PetscMemcpy(&ls,&snes,sizeof(snes));CHKERRQ(ierr); 491061b2408cSBarry Smith ierr = PetscMemcpy(&lx,&x,sizeof(x));CHKERRQ(ierr); 491161b2408cSBarry Smith ierr = PetscMemcpy(&lA,A,sizeof(x));CHKERRQ(ierr); 491261b2408cSBarry Smith ierr = PetscMemcpy(&lB,B,sizeof(x));CHKERRQ(ierr); 491361b2408cSBarry Smith prhs[0] = mxCreateDoubleScalar((double)ls); 491461b2408cSBarry Smith prhs[1] = mxCreateDoubleScalar((double)lx); 491561b2408cSBarry Smith prhs[2] = mxCreateDoubleScalar((double)lA); 491661b2408cSBarry Smith prhs[3] = mxCreateDoubleScalar((double)lB); 491761b2408cSBarry Smith prhs[4] = mxCreateString(sctx->funcname); 491861b2408cSBarry Smith prhs[5] = sctx->ctx; 4919b807a863SBarry Smith ierr = mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscSNESComputeJacobianInternal");CHKERRQ(ierr); 492061b2408cSBarry Smith ierr = mxGetScalar(plhs[0]);CHKERRQ(ierr); 492161b2408cSBarry Smith *flag = (MatStructure) mxGetScalar(plhs[1]);CHKERRQ(ierr); 492261b2408cSBarry Smith mxDestroyArray(prhs[0]); 492361b2408cSBarry Smith mxDestroyArray(prhs[1]); 492461b2408cSBarry Smith mxDestroyArray(prhs[2]); 492561b2408cSBarry Smith mxDestroyArray(prhs[3]); 492661b2408cSBarry Smith mxDestroyArray(prhs[4]); 492761b2408cSBarry Smith mxDestroyArray(plhs[0]); 492861b2408cSBarry Smith mxDestroyArray(plhs[1]); 492961b2408cSBarry Smith PetscFunctionReturn(0); 493061b2408cSBarry Smith } 493161b2408cSBarry Smith 493261b2408cSBarry Smith #undef __FUNCT__ 493361b2408cSBarry Smith #define __FUNCT__ "SNESSetJacobianMatlab" 493461b2408cSBarry Smith /* 493561b2408cSBarry Smith SNESSetJacobianMatlab - Sets the Jacobian function evaluation routine and two empty Jacobian matrices 493661b2408cSBarry Smith vector for use by the SNES routines in solving systems of nonlinear 4937e3c5b3baSBarry Smith equations from MATLAB. Here the function is a string containing the name of a MATLAB function 493861b2408cSBarry Smith 493961b2408cSBarry Smith Logically Collective on SNES 494061b2408cSBarry Smith 494161b2408cSBarry Smith Input Parameters: 494261b2408cSBarry Smith + snes - the SNES context 494361b2408cSBarry Smith . A,B - Jacobian matrices 4944*bf388a1fSBarry Smith . SNESJacobianFunction - function evaluation routine 494561b2408cSBarry Smith - ctx - user context 494661b2408cSBarry Smith 494761b2408cSBarry Smith Level: developer 494861b2408cSBarry Smith 494961b2408cSBarry Smith .keywords: SNES, nonlinear, set, function 495061b2408cSBarry Smith 4951*bf388a1fSBarry Smith .seealso: SNESGetFunction(), SNESComputeFunction(), SNESSetJacobian(), SNESSetFunction(), SNESJacobianFunction 495261b2408cSBarry Smith */ 4953*bf388a1fSBarry Smith PetscErrorCode SNESSetJacobianMatlab(SNES snes,Mat A,Mat B,const char *SNESJacobianFunction,mxArray *ctx) 495461b2408cSBarry Smith { 495561b2408cSBarry Smith PetscErrorCode ierr; 495661b2408cSBarry Smith SNESMatlabContext *sctx; 495761b2408cSBarry Smith 495861b2408cSBarry Smith PetscFunctionBegin; 495961b2408cSBarry Smith /* currently sctx is memory bleed */ 496061b2408cSBarry Smith ierr = PetscMalloc(sizeof(SNESMatlabContext),&sctx);CHKERRQ(ierr); 4961*bf388a1fSBarry Smith ierr = PetscStrallocpy(SNESJacobianFunction,&sctx->funcname);CHKERRQ(ierr); 496261b2408cSBarry Smith /* 496361b2408cSBarry Smith This should work, but it doesn't 496461b2408cSBarry Smith sctx->ctx = ctx; 496561b2408cSBarry Smith mexMakeArrayPersistent(sctx->ctx); 496661b2408cSBarry Smith */ 496761b2408cSBarry Smith sctx->ctx = mxDuplicateArray(ctx); 496861b2408cSBarry Smith ierr = SNESSetJacobian(snes,A,B,SNESComputeJacobian_Matlab,sctx);CHKERRQ(ierr); 496961b2408cSBarry Smith PetscFunctionReturn(0); 497061b2408cSBarry Smith } 497169b4f73cSBarry Smith 4972f9eb7ae2SShri Abhyankar #undef __FUNCT__ 4973f9eb7ae2SShri Abhyankar #define __FUNCT__ "SNESMonitor_Matlab" 4974f9eb7ae2SShri Abhyankar /* 4975f9eb7ae2SShri Abhyankar SNESMonitor_Matlab - Calls the function that has been set with SNESMonitorSetMatlab(). 4976f9eb7ae2SShri Abhyankar 4977f9eb7ae2SShri Abhyankar Collective on SNES 4978f9eb7ae2SShri Abhyankar 4979f9eb7ae2SShri Abhyankar .seealso: SNESSetFunction(), SNESGetFunction() 4980f9eb7ae2SShri Abhyankar @*/ 49817087cfbeSBarry Smith PetscErrorCode SNESMonitor_Matlab(SNES snes,PetscInt it, PetscReal fnorm, void *ctx) 4982f9eb7ae2SShri Abhyankar { 4983f9eb7ae2SShri Abhyankar PetscErrorCode ierr; 498448f37e70SShri Abhyankar SNESMatlabContext *sctx = (SNESMatlabContext *)ctx; 4985f9eb7ae2SShri Abhyankar int nlhs = 1,nrhs = 6; 4986f9eb7ae2SShri Abhyankar mxArray *plhs[1],*prhs[6]; 4987f9eb7ae2SShri Abhyankar long long int lx = 0,ls = 0; 4988f9eb7ae2SShri Abhyankar Vec x=snes->vec_sol; 4989f9eb7ae2SShri Abhyankar 4990f9eb7ae2SShri Abhyankar PetscFunctionBegin; 4991f9eb7ae2SShri Abhyankar PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 4992f9eb7ae2SShri Abhyankar 4993f9eb7ae2SShri Abhyankar ierr = PetscMemcpy(&ls,&snes,sizeof(snes));CHKERRQ(ierr); 4994f9eb7ae2SShri Abhyankar ierr = PetscMemcpy(&lx,&x,sizeof(x));CHKERRQ(ierr); 4995f9eb7ae2SShri Abhyankar prhs[0] = mxCreateDoubleScalar((double)ls); 4996f9eb7ae2SShri Abhyankar prhs[1] = mxCreateDoubleScalar((double)it); 4997f9eb7ae2SShri Abhyankar prhs[2] = mxCreateDoubleScalar((double)fnorm); 4998f9eb7ae2SShri Abhyankar prhs[3] = mxCreateDoubleScalar((double)lx); 4999f9eb7ae2SShri Abhyankar prhs[4] = mxCreateString(sctx->funcname); 5000f9eb7ae2SShri Abhyankar prhs[5] = sctx->ctx; 5001f9eb7ae2SShri Abhyankar ierr = mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscSNESMonitorInternal");CHKERRQ(ierr); 5002f9eb7ae2SShri Abhyankar ierr = mxGetScalar(plhs[0]);CHKERRQ(ierr); 5003f9eb7ae2SShri Abhyankar mxDestroyArray(prhs[0]); 5004f9eb7ae2SShri Abhyankar mxDestroyArray(prhs[1]); 5005f9eb7ae2SShri Abhyankar mxDestroyArray(prhs[2]); 5006f9eb7ae2SShri Abhyankar mxDestroyArray(prhs[3]); 5007f9eb7ae2SShri Abhyankar mxDestroyArray(prhs[4]); 5008f9eb7ae2SShri Abhyankar mxDestroyArray(plhs[0]); 5009f9eb7ae2SShri Abhyankar PetscFunctionReturn(0); 5010f9eb7ae2SShri Abhyankar } 5011f9eb7ae2SShri Abhyankar 5012f9eb7ae2SShri Abhyankar #undef __FUNCT__ 5013f9eb7ae2SShri Abhyankar #define __FUNCT__ "SNESMonitorSetMatlab" 5014f9eb7ae2SShri Abhyankar /* 5015e3c5b3baSBarry Smith SNESMonitorSetMatlab - Sets the monitor function from MATLAB 5016f9eb7ae2SShri Abhyankar 5017f9eb7ae2SShri Abhyankar Level: developer 5018f9eb7ae2SShri Abhyankar 5019f9eb7ae2SShri Abhyankar .keywords: SNES, nonlinear, set, function 5020f9eb7ae2SShri Abhyankar 5021f9eb7ae2SShri Abhyankar .seealso: SNESGetFunction(), SNESComputeFunction(), SNESSetJacobian(), SNESSetFunction() 5022f9eb7ae2SShri Abhyankar */ 5023*bf388a1fSBarry Smith PetscErrorCode SNESMonitorSetMatlab(SNES snes,const char *SNESMonitorFunction,mxArray *ctx) 5024f9eb7ae2SShri Abhyankar { 5025f9eb7ae2SShri Abhyankar PetscErrorCode ierr; 5026f9eb7ae2SShri Abhyankar SNESMatlabContext *sctx; 5027f9eb7ae2SShri Abhyankar 5028f9eb7ae2SShri Abhyankar PetscFunctionBegin; 5029f9eb7ae2SShri Abhyankar /* currently sctx is memory bleed */ 5030f9eb7ae2SShri Abhyankar ierr = PetscMalloc(sizeof(SNESMatlabContext),&sctx);CHKERRQ(ierr); 5031*bf388a1fSBarry Smith ierr = PetscStrallocpy(SNESMonitorFunction,&sctx->funcname);CHKERRQ(ierr); 5032f9eb7ae2SShri Abhyankar /* 5033f9eb7ae2SShri Abhyankar This should work, but it doesn't 5034f9eb7ae2SShri Abhyankar sctx->ctx = ctx; 5035f9eb7ae2SShri Abhyankar mexMakeArrayPersistent(sctx->ctx); 5036f9eb7ae2SShri Abhyankar */ 5037f9eb7ae2SShri Abhyankar sctx->ctx = mxDuplicateArray(ctx); 5038f9eb7ae2SShri Abhyankar ierr = SNESMonitorSet(snes,SNESMonitor_Matlab,sctx,PETSC_NULL);CHKERRQ(ierr); 5039f9eb7ae2SShri Abhyankar PetscFunctionReturn(0); 5040f9eb7ae2SShri Abhyankar } 5041f9eb7ae2SShri Abhyankar 504269b4f73cSBarry Smith #endif 5043