19b94acceSBarry Smith 2b45d2f2cSJed Brown #include <petsc-private/snesimpl.h> /*I "petscsnes.h" I*/ 307475bc1SBarry Smith #include <petscdmshell.h> 49b94acceSBarry Smith 5ace3abfcSBarry Smith PetscBool SNESRegisterAllCalled = PETSC_FALSE; 60298fd71SBarry Smith PetscFunctionList SNESList = NULL; 78ba1e511SMatthew Knepley 88ba1e511SMatthew Knepley /* Logging support */ 922c6f798SBarry Smith PetscClassId SNES_CLASSID, DMSNES_CLASSID; 1063e7833aSPeter Brune PetscLogEvent SNES_Solve, SNES_FunctionEval, SNES_JacobianEval, SNES_GSEval, SNES_NPCSolve; 11a09944afSBarry Smith 12a09944afSBarry Smith #undef __FUNCT__ 13e113a28aSBarry Smith #define __FUNCT__ "SNESSetErrorIfNotConverged" 14e113a28aSBarry Smith /*@ 15e113a28aSBarry Smith SNESSetErrorIfNotConverged - Causes SNESSolve() to generate an error if the solver has not converged. 16e113a28aSBarry Smith 173f9fe445SBarry Smith Logically Collective on SNES 18e113a28aSBarry Smith 19e113a28aSBarry Smith Input Parameters: 20e113a28aSBarry Smith + snes - iterative context obtained from SNESCreate() 21e113a28aSBarry Smith - flg - PETSC_TRUE indicates you want the error generated 22e113a28aSBarry Smith 23e113a28aSBarry Smith Options database keys: 24e113a28aSBarry Smith . -snes_error_if_not_converged : this takes an optional truth value (0/1/no/yes/true/false) 25e113a28aSBarry Smith 26e113a28aSBarry Smith Level: intermediate 27e113a28aSBarry Smith 28e113a28aSBarry Smith Notes: 29e113a28aSBarry Smith Normally PETSc continues if a linear solver fails to converge, you can call SNESGetConvergedReason() after a SNESSolve() 30e113a28aSBarry Smith to determine if it has converged. 31e113a28aSBarry Smith 32e113a28aSBarry Smith .keywords: SNES, set, initial guess, nonzero 33e113a28aSBarry Smith 34e113a28aSBarry Smith .seealso: SNESGetErrorIfNotConverged(), KSPGetErrorIfNotConverged(), KSPSetErrorIFNotConverged() 35e113a28aSBarry Smith @*/ 367087cfbeSBarry Smith PetscErrorCode SNESSetErrorIfNotConverged(SNES snes,PetscBool flg) 37e113a28aSBarry Smith { 38e113a28aSBarry Smith PetscFunctionBegin; 39e113a28aSBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 40acfcf0e5SJed Brown PetscValidLogicalCollectiveBool(snes,flg,2); 41e113a28aSBarry Smith snes->errorifnotconverged = flg; 42e113a28aSBarry Smith PetscFunctionReturn(0); 43e113a28aSBarry Smith } 44e113a28aSBarry Smith 45e113a28aSBarry Smith #undef __FUNCT__ 46e113a28aSBarry Smith #define __FUNCT__ "SNESGetErrorIfNotConverged" 47e113a28aSBarry Smith /*@ 48e113a28aSBarry Smith SNESGetErrorIfNotConverged - Will SNESSolve() generate an error if the solver does not converge? 49e113a28aSBarry Smith 50e113a28aSBarry Smith Not Collective 51e113a28aSBarry Smith 52e113a28aSBarry Smith Input Parameter: 53e113a28aSBarry Smith . snes - iterative context obtained from SNESCreate() 54e113a28aSBarry Smith 55e113a28aSBarry Smith Output Parameter: 56e113a28aSBarry Smith . flag - PETSC_TRUE if it will generate an error, else PETSC_FALSE 57e113a28aSBarry Smith 58e113a28aSBarry Smith Level: intermediate 59e113a28aSBarry Smith 60e113a28aSBarry Smith .keywords: SNES, set, initial guess, nonzero 61e113a28aSBarry Smith 62e113a28aSBarry Smith .seealso: SNESSetErrorIfNotConverged(), KSPGetErrorIfNotConverged(), KSPSetErrorIFNotConverged() 63e113a28aSBarry Smith @*/ 647087cfbeSBarry Smith PetscErrorCode SNESGetErrorIfNotConverged(SNES snes,PetscBool *flag) 65e113a28aSBarry Smith { 66e113a28aSBarry Smith PetscFunctionBegin; 67e113a28aSBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 68e113a28aSBarry Smith PetscValidPointer(flag,2); 69e113a28aSBarry Smith *flag = snes->errorifnotconverged; 70e113a28aSBarry Smith PetscFunctionReturn(0); 71e113a28aSBarry Smith } 72e113a28aSBarry Smith 73e113a28aSBarry Smith #undef __FUNCT__ 744936397dSBarry Smith #define __FUNCT__ "SNESSetFunctionDomainError" 75e725d27bSBarry Smith /*@ 76bf388a1fSBarry Smith SNESSetFunctionDomainError - tells SNES that the input vector to your SNESFunction is not 774936397dSBarry Smith in the functions domain. For example, negative pressure. 784936397dSBarry Smith 793f9fe445SBarry Smith Logically Collective on SNES 804936397dSBarry Smith 814936397dSBarry Smith Input Parameters: 826a388c36SPeter Brune . snes - the SNES context 834936397dSBarry Smith 8428529972SSatish Balay Level: advanced 854936397dSBarry Smith 864936397dSBarry Smith .keywords: SNES, view 874936397dSBarry Smith 88bf388a1fSBarry Smith .seealso: SNESCreate(), SNESSetFunction(), SNESFunction 894936397dSBarry Smith @*/ 907087cfbeSBarry Smith PetscErrorCode SNESSetFunctionDomainError(SNES snes) 914936397dSBarry Smith { 924936397dSBarry Smith PetscFunctionBegin; 930700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 944936397dSBarry Smith snes->domainerror = PETSC_TRUE; 954936397dSBarry Smith PetscFunctionReturn(0); 964936397dSBarry Smith } 974936397dSBarry Smith 986a388c36SPeter Brune #undef __FUNCT__ 996a388c36SPeter Brune #define __FUNCT__ "SNESGetFunctionDomainError" 1006a388c36SPeter Brune /*@ 101c77b2880SPeter Brune SNESGetFunctionDomainError - Gets the status of the domain error after a call to SNESComputeFunction; 1026a388c36SPeter Brune 1036a388c36SPeter Brune Logically Collective on SNES 1046a388c36SPeter Brune 1056a388c36SPeter Brune Input Parameters: 1066a388c36SPeter Brune . snes - the SNES context 1076a388c36SPeter Brune 1086a388c36SPeter Brune Output Parameters: 109bf388a1fSBarry Smith . domainerror - Set to PETSC_TRUE if there's a domain error; PETSC_FALSE otherwise. 1106a388c36SPeter Brune 1116a388c36SPeter Brune Level: advanced 1126a388c36SPeter Brune 1136a388c36SPeter Brune .keywords: SNES, view 1146a388c36SPeter Brune 115bf388a1fSBarry Smith .seealso: SNESSetFunctionDomainError(), SNESComputeFunction() 1166a388c36SPeter Brune @*/ 1176a388c36SPeter Brune PetscErrorCode SNESGetFunctionDomainError(SNES snes, PetscBool *domainerror) 1186a388c36SPeter Brune { 1196a388c36SPeter Brune PetscFunctionBegin; 1206a388c36SPeter Brune PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 1216a388c36SPeter Brune PetscValidPointer(domainerror, 2); 1226a388c36SPeter Brune *domainerror = snes->domainerror; 1236a388c36SPeter Brune PetscFunctionReturn(0); 1246a388c36SPeter Brune } 1256a388c36SPeter Brune 12655849f57SBarry Smith #undef __FUNCT__ 12755849f57SBarry Smith #define __FUNCT__ "SNESLoad" 12855849f57SBarry Smith /*@C 12955849f57SBarry Smith SNESLoad - Loads a SNES that has been stored in binary with SNESView(). 13055849f57SBarry Smith 13155849f57SBarry Smith Collective on PetscViewer 13255849f57SBarry Smith 13355849f57SBarry Smith Input Parameters: 13455849f57SBarry Smith + newdm - the newly loaded SNES, this needs to have been created with SNESCreate() or 13555849f57SBarry Smith some related function before a call to SNESLoad(). 13655849f57SBarry Smith - viewer - binary file viewer, obtained from PetscViewerBinaryOpen() 13755849f57SBarry Smith 13855849f57SBarry Smith Level: intermediate 13955849f57SBarry Smith 14055849f57SBarry Smith Notes: 14155849f57SBarry Smith The type is determined by the data in the file, any type set into the SNES before this call is ignored. 14255849f57SBarry Smith 14355849f57SBarry Smith Notes for advanced users: 14455849f57SBarry Smith Most users should not need to know the details of the binary storage 14555849f57SBarry Smith format, since SNESLoad() and TSView() completely hide these details. 14655849f57SBarry Smith But for anyone who's interested, the standard binary matrix storage 14755849f57SBarry Smith format is 14855849f57SBarry Smith .vb 14955849f57SBarry Smith has not yet been determined 15055849f57SBarry Smith .ve 15155849f57SBarry Smith 15255849f57SBarry Smith .seealso: PetscViewerBinaryOpen(), SNESView(), MatLoad(), VecLoad() 15355849f57SBarry Smith @*/ 1542d53ad75SBarry Smith PetscErrorCode SNESLoad(SNES snes, PetscViewer viewer) 15555849f57SBarry Smith { 15655849f57SBarry Smith PetscErrorCode ierr; 15755849f57SBarry Smith PetscBool isbinary; 15855849f57SBarry Smith PetscInt classid; 15955849f57SBarry Smith char type[256]; 16055849f57SBarry Smith KSP ksp; 1612d53ad75SBarry Smith DM dm; 1622d53ad75SBarry Smith DMSNES dmsnes; 16355849f57SBarry Smith 16455849f57SBarry Smith PetscFunctionBegin; 1652d53ad75SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 16655849f57SBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 16755849f57SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr); 16855849f57SBarry Smith if (!isbinary) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Invalid viewer; open viewer with PetscViewerBinaryOpen()"); 16955849f57SBarry Smith 17055849f57SBarry Smith ierr = PetscViewerBinaryRead(viewer,&classid,1,PETSC_INT);CHKERRQ(ierr); 171ce94432eSBarry Smith if (classid != SNES_FILE_CLASSID) SETERRQ(PetscObjectComm((PetscObject)snes),PETSC_ERR_ARG_WRONG,"Not SNES next in file"); 17255849f57SBarry Smith ierr = PetscViewerBinaryRead(viewer,type,256,PETSC_CHAR);CHKERRQ(ierr); 1732d53ad75SBarry Smith ierr = SNESSetType(snes, type);CHKERRQ(ierr); 1742d53ad75SBarry Smith if (snes->ops->load) { 1752d53ad75SBarry Smith ierr = (*snes->ops->load)(snes,viewer);CHKERRQ(ierr); 176f2c2a1b9SBarry Smith } 1772d53ad75SBarry Smith ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr); 1782d53ad75SBarry Smith ierr = DMGetDMSNES(dm,&dmsnes);CHKERRQ(ierr); 1792d53ad75SBarry Smith ierr = DMSNESLoad(dmsnes,viewer);CHKERRQ(ierr); 1802d53ad75SBarry Smith ierr = SNESGetKSP(snes,&ksp);CHKERRQ(ierr); 18155849f57SBarry Smith ierr = KSPLoad(ksp,viewer);CHKERRQ(ierr); 18255849f57SBarry Smith PetscFunctionReturn(0); 18355849f57SBarry Smith } 1846a388c36SPeter Brune 1859804daf3SBarry Smith #include <petscdraw.h> 186bfb97211SBarry Smith #if defined(PETSC_HAVE_AMS) 187bfb97211SBarry Smith #include <petscviewerams.h> 188bfb97211SBarry Smith #endif 1894936397dSBarry Smith #undef __FUNCT__ 1904a2ae208SSatish Balay #define __FUNCT__ "SNESView" 1917e2c5f70SBarry Smith /*@C 1929b94acceSBarry Smith SNESView - Prints the SNES data structure. 1939b94acceSBarry Smith 1944c49b128SBarry Smith Collective on SNES 195fee21e36SBarry Smith 196c7afd0dbSLois Curfman McInnes Input Parameters: 197c7afd0dbSLois Curfman McInnes + SNES - the SNES context 198c7afd0dbSLois Curfman McInnes - viewer - visualization context 199c7afd0dbSLois Curfman McInnes 2009b94acceSBarry Smith Options Database Key: 201c8a8ba5cSLois Curfman McInnes . -snes_view - Calls SNESView() at end of SNESSolve() 2029b94acceSBarry Smith 2039b94acceSBarry Smith Notes: 2049b94acceSBarry Smith The available visualization contexts include 205b0a32e0cSBarry Smith + PETSC_VIEWER_STDOUT_SELF - standard output (default) 206b0a32e0cSBarry Smith - PETSC_VIEWER_STDOUT_WORLD - synchronized standard 207c8a8ba5cSLois Curfman McInnes output where only the first processor opens 208c8a8ba5cSLois Curfman McInnes the file. All other processors send their 209c8a8ba5cSLois Curfman McInnes data to the first processor to print. 2109b94acceSBarry Smith 2113e081fefSLois Curfman McInnes The user can open an alternative visualization context with 212b0a32e0cSBarry Smith PetscViewerASCIIOpen() - output to a specified file. 2139b94acceSBarry Smith 21436851e7fSLois Curfman McInnes Level: beginner 21536851e7fSLois Curfman McInnes 2169b94acceSBarry Smith .keywords: SNES, view 2179b94acceSBarry Smith 218b0a32e0cSBarry Smith .seealso: PetscViewerASCIIOpen() 2199b94acceSBarry Smith @*/ 2207087cfbeSBarry Smith PetscErrorCode SNESView(SNES snes,PetscViewer viewer) 2219b94acceSBarry Smith { 222fa9f3622SBarry Smith SNESKSPEW *kctx; 223dfbe8321SBarry Smith PetscErrorCode ierr; 22494b7f48cSBarry Smith KSP ksp; 2257f1410a3SPeter Brune SNESLineSearch linesearch; 22672a02f06SBarry Smith PetscBool iascii,isstring,isbinary,isdraw; 2272d53ad75SBarry Smith DMSNES dmsnes; 228bfb97211SBarry Smith #if defined(PETSC_HAVE_AMS) 229bfb97211SBarry Smith PetscBool isams; 230bfb97211SBarry Smith #endif 2319b94acceSBarry Smith 2323a40ed3dSBarry Smith PetscFunctionBegin; 2330700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 2343050cee2SBarry Smith if (!viewer) { 235ce94432eSBarry Smith ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)snes),&viewer);CHKERRQ(ierr); 2363050cee2SBarry Smith } 2370700a824SBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 238c9780b6fSBarry Smith PetscCheckSameComm(snes,1,viewer,2); 23974679c65SBarry Smith 240251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr); 241251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSTRING,&isstring);CHKERRQ(ierr); 24255849f57SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr); 24372a02f06SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr); 244bfb97211SBarry Smith #if defined(PETSC_HAVE_AMS) 245bfb97211SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERAMS,&isams);CHKERRQ(ierr); 246bfb97211SBarry Smith #endif 24732077d6dSBarry Smith if (iascii) { 248dae58748SBarry Smith ierr = PetscObjectPrintClassNamePrefixType((PetscObject)snes,viewer);CHKERRQ(ierr); 249fce1e034SJed Brown if (!snes->setupcalled) { 250fce1e034SJed Brown ierr = PetscViewerASCIIPrintf(viewer," SNES has not been set up so information may be incomplete\n");CHKERRQ(ierr); 251fce1e034SJed Brown } 252e7788613SBarry Smith if (snes->ops->view) { 253b0a32e0cSBarry Smith ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 254e7788613SBarry Smith ierr = (*snes->ops->view)(snes,viewer);CHKERRQ(ierr); 255b0a32e0cSBarry Smith ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 2560ef38995SBarry Smith } 25777431f27SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," maximum iterations=%D, maximum function evaluations=%D\n",snes->max_its,snes->max_funcs);CHKERRQ(ierr); 258f5af7f23SKarl Rupp ierr = PetscViewerASCIIPrintf(viewer," tolerances: relative=%G, absolute=%G, solution=%G\n",snes->rtol,snes->abstol,snes->stol);CHKERRQ(ierr); 25977431f27SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," total number of linear solver iterations=%D\n",snes->linear_its);CHKERRQ(ierr); 26077431f27SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," total number of function evaluations=%D\n",snes->nfuncs);CHKERRQ(ierr); 26117fe4bdfSPeter Brune if (snes->gridsequence) { 26217fe4bdfSPeter Brune ierr = PetscViewerASCIIPrintf(viewer," total number of grid sequence refinements=%D\n",snes->gridsequence);CHKERRQ(ierr); 26317fe4bdfSPeter Brune } 2649b94acceSBarry Smith if (snes->ksp_ewconv) { 265fa9f3622SBarry Smith kctx = (SNESKSPEW*)snes->kspconvctx; 2669b94acceSBarry Smith if (kctx) { 26777431f27SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," Eisenstat-Walker computation of KSP relative tolerance (version %D)\n",kctx->version);CHKERRQ(ierr); 268a83599f4SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," rtol_0=%G, rtol_max=%G, threshold=%G\n",kctx->rtol_0,kctx->rtol_max,kctx->threshold);CHKERRQ(ierr); 269a83599f4SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," gamma=%G, alpha=%G, alpha2=%G\n",kctx->gamma,kctx->alpha,kctx->alpha2);CHKERRQ(ierr); 2709b94acceSBarry Smith } 2719b94acceSBarry Smith } 272eb1f6c34SBarry Smith if (snes->lagpreconditioner == -1) { 273eb1f6c34SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," Preconditioned is never rebuilt\n");CHKERRQ(ierr); 274eb1f6c34SBarry Smith } else if (snes->lagpreconditioner > 1) { 275eb1f6c34SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," Preconditioned is rebuilt every %D new Jacobians\n",snes->lagpreconditioner);CHKERRQ(ierr); 276eb1f6c34SBarry Smith } 277eb1f6c34SBarry Smith if (snes->lagjacobian == -1) { 278eb1f6c34SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," Jacobian is never rebuilt\n");CHKERRQ(ierr); 279eb1f6c34SBarry Smith } else if (snes->lagjacobian > 1) { 28042f4f86dSBarry Smith ierr = PetscViewerASCIIPrintf(viewer," Jacobian is rebuilt every %D SNES iterations\n",snes->lagjacobian);CHKERRQ(ierr); 281eb1f6c34SBarry Smith } 2820f5bd95cSBarry Smith } else if (isstring) { 283317d6ea6SBarry Smith const char *type; 284454a90a3SBarry Smith ierr = SNESGetType(snes,&type);CHKERRQ(ierr); 285b0a32e0cSBarry Smith ierr = PetscViewerStringSPrintf(viewer," %-3.3s",type);CHKERRQ(ierr); 28655849f57SBarry Smith } else if (isbinary) { 28755849f57SBarry Smith PetscInt classid = SNES_FILE_CLASSID; 28855849f57SBarry Smith MPI_Comm comm; 28955849f57SBarry Smith PetscMPIInt rank; 29055849f57SBarry Smith char type[256]; 29155849f57SBarry Smith 29255849f57SBarry Smith ierr = PetscObjectGetComm((PetscObject)snes,&comm);CHKERRQ(ierr); 29355849f57SBarry Smith ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr); 29455849f57SBarry Smith if (!rank) { 29555849f57SBarry Smith ierr = PetscViewerBinaryWrite(viewer,&classid,1,PETSC_INT,PETSC_FALSE);CHKERRQ(ierr); 29655849f57SBarry Smith ierr = PetscStrncpy(type,((PetscObject)snes)->type_name,256);CHKERRQ(ierr); 29755849f57SBarry Smith ierr = PetscViewerBinaryWrite(viewer,type,256,PETSC_CHAR,PETSC_FALSE);CHKERRQ(ierr); 29855849f57SBarry Smith } 29955849f57SBarry Smith if (snes->ops->view) { 30055849f57SBarry Smith ierr = (*snes->ops->view)(snes,viewer);CHKERRQ(ierr); 30155849f57SBarry Smith } 30272a02f06SBarry Smith } else if (isdraw) { 30372a02f06SBarry Smith PetscDraw draw; 30472a02f06SBarry Smith char str[36]; 30589fd9fafSBarry Smith PetscReal x,y,bottom,h; 30672a02f06SBarry Smith 30772a02f06SBarry Smith ierr = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr); 30872a02f06SBarry Smith ierr = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr); 30972a02f06SBarry Smith ierr = PetscStrcpy(str,"SNES: ");CHKERRQ(ierr); 31072a02f06SBarry Smith ierr = PetscStrcat(str,((PetscObject)snes)->type_name);CHKERRQ(ierr); 3110298fd71SBarry Smith ierr = PetscDrawBoxedString(draw,x,y,PETSC_DRAW_BLUE,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr); 31289fd9fafSBarry Smith bottom = y - h; 31372a02f06SBarry Smith ierr = PetscDrawPushCurrentPoint(draw,x,bottom);CHKERRQ(ierr); 314c4646bacSPeter Brune if (snes->ops->view) { 315c4646bacSPeter Brune ierr = (*snes->ops->view)(snes,viewer);CHKERRQ(ierr); 316c4646bacSPeter Brune } 317bfb97211SBarry Smith #if defined(PETSC_HAVE_AMS) 318bfb97211SBarry Smith } else if (isams) { 319f05ece33SBarry Smith if (((PetscObject)snes)->amsmem == -1) { 320bfb97211SBarry Smith ierr = PetscObjectViewAMS((PetscObject)snes,viewer);CHKERRQ(ierr); 321f05ece33SBarry Smith PetscStackCallAMS(AMS_Memory_take_access,(((PetscObject)snes)->amsmem)); 322f05ece33SBarry Smith PetscStackCallAMS(AMS_Memory_add_field,(((PetscObject)snes)->amsmem,"its",&snes->iter,1,AMS_INT,AMS_READ,AMS_COMMON,AMS_REDUCT_UNDEF)); 323bfb97211SBarry Smith if (!snes->conv_hist) { 324bfb97211SBarry Smith ierr = SNESSetConvergenceHistory(snes,NULL,NULL,PETSC_DECIDE,PETSC_FALSE);CHKERRQ(ierr); 325bfb97211SBarry Smith } 326f05ece33SBarry Smith PetscStackCallAMS(AMS_Memory_add_field,(((PetscObject)snes)->amsmem,"conv_hist",snes->conv_hist,10,AMS_DOUBLE,AMS_READ,AMS_COMMON,AMS_REDUCT_UNDEF)); 327f05ece33SBarry Smith PetscStackCallAMS(AMS_Memory_grant_access,(((PetscObject)snes)->amsmem)); 328f05ece33SBarry Smith } 329bfb97211SBarry Smith #endif 33072a02f06SBarry Smith } 33172a02f06SBarry Smith if (snes->linesearch) { 33272a02f06SBarry Smith ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 3337601faf0SJed Brown ierr = SNESGetLineSearch(snes, &linesearch);CHKERRQ(ierr); 33472a02f06SBarry Smith ierr = SNESLineSearchView(linesearch, viewer);CHKERRQ(ierr); 33572a02f06SBarry Smith ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 33619bcc07fSBarry Smith } 33742f4f86dSBarry Smith if (snes->pc && snes->usespc) { 3384a0c5b0cSMatthew G Knepley ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 3394a0c5b0cSMatthew G Knepley ierr = SNESView(snes->pc, viewer);CHKERRQ(ierr); 3404a0c5b0cSMatthew G Knepley ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 3414a0c5b0cSMatthew G Knepley } 3422d53ad75SBarry Smith ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 3432d53ad75SBarry Smith ierr = DMGetDMSNES(snes->dm,&dmsnes);CHKERRQ(ierr); 3442d53ad75SBarry Smith ierr = DMSNESView(dmsnes, viewer);CHKERRQ(ierr); 3452d53ad75SBarry Smith ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 3462c155ee1SBarry Smith if (snes->usesksp) { 3472c155ee1SBarry Smith ierr = SNESGetKSP(snes,&ksp);CHKERRQ(ierr); 348b0a32e0cSBarry Smith ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 34994b7f48cSBarry Smith ierr = KSPView(ksp,viewer);CHKERRQ(ierr); 350b0a32e0cSBarry Smith ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 3512c155ee1SBarry Smith } 35272a02f06SBarry Smith if (isdraw) { 35372a02f06SBarry Smith PetscDraw draw; 35472a02f06SBarry Smith ierr = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr); 35572a02f06SBarry Smith ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr); 3567f1410a3SPeter Brune } 3573a40ed3dSBarry Smith PetscFunctionReturn(0); 3589b94acceSBarry Smith } 3599b94acceSBarry Smith 36076b2cf59SMatthew Knepley /* 36176b2cf59SMatthew Knepley We retain a list of functions that also take SNES command 36276b2cf59SMatthew Knepley line options. These are called at the end SNESSetFromOptions() 36376b2cf59SMatthew Knepley */ 36476b2cf59SMatthew Knepley #define MAXSETFROMOPTIONS 5 365a7cc72afSBarry Smith static PetscInt numberofsetfromoptions; 3666849ba73SBarry Smith static PetscErrorCode (*othersetfromoptions[MAXSETFROMOPTIONS])(SNES); 36776b2cf59SMatthew Knepley 368e74ef692SMatthew Knepley #undef __FUNCT__ 369e74ef692SMatthew Knepley #define __FUNCT__ "SNESAddOptionsChecker" 370ac226902SBarry Smith /*@C 37176b2cf59SMatthew Knepley SNESAddOptionsChecker - Adds an additional function to check for SNES options. 37276b2cf59SMatthew Knepley 37376b2cf59SMatthew Knepley Not Collective 37476b2cf59SMatthew Knepley 37576b2cf59SMatthew Knepley Input Parameter: 37676b2cf59SMatthew Knepley . snescheck - function that checks for options 37776b2cf59SMatthew Knepley 37876b2cf59SMatthew Knepley Level: developer 37976b2cf59SMatthew Knepley 38076b2cf59SMatthew Knepley .seealso: SNESSetFromOptions() 38176b2cf59SMatthew Knepley @*/ 3827087cfbeSBarry Smith PetscErrorCode SNESAddOptionsChecker(PetscErrorCode (*snescheck)(SNES)) 38376b2cf59SMatthew Knepley { 38476b2cf59SMatthew Knepley PetscFunctionBegin; 385f23aa3ddSBarry Smith if (numberofsetfromoptions >= MAXSETFROMOPTIONS) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE, "Too many options checkers, only %D allowed", MAXSETFROMOPTIONS); 38676b2cf59SMatthew Knepley othersetfromoptions[numberofsetfromoptions++] = snescheck; 38776b2cf59SMatthew Knepley PetscFunctionReturn(0); 38876b2cf59SMatthew Knepley } 38976b2cf59SMatthew Knepley 3907087cfbeSBarry Smith extern PetscErrorCode SNESDefaultMatrixFreeCreate2(SNES,Vec,Mat*); 391aa3661deSLisandro Dalcin 392aa3661deSLisandro Dalcin #undef __FUNCT__ 393aa3661deSLisandro Dalcin #define __FUNCT__ "SNESSetUpMatrixFree_Private" 394ace3abfcSBarry Smith static PetscErrorCode SNESSetUpMatrixFree_Private(SNES snes, PetscBool hasOperator, PetscInt version) 395aa3661deSLisandro Dalcin { 396aa3661deSLisandro Dalcin Mat J; 397aa3661deSLisandro Dalcin KSP ksp; 398aa3661deSLisandro Dalcin PC pc; 399ace3abfcSBarry Smith PetscBool match; 400aa3661deSLisandro Dalcin PetscErrorCode ierr; 401aa3661deSLisandro Dalcin 402aa3661deSLisandro Dalcin PetscFunctionBegin; 4030700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 404aa3661deSLisandro Dalcin 40598613b67SLisandro Dalcin if (!snes->vec_func && (snes->jacobian || snes->jacobian_pre)) { 40698613b67SLisandro Dalcin Mat A = snes->jacobian, B = snes->jacobian_pre; 4070298fd71SBarry Smith ierr = MatGetVecs(A ? A : B, NULL,&snes->vec_func);CHKERRQ(ierr); 40898613b67SLisandro Dalcin } 40998613b67SLisandro Dalcin 410aa3661deSLisandro Dalcin if (version == 1) { 411aa3661deSLisandro Dalcin ierr = MatCreateSNESMF(snes,&J);CHKERRQ(ierr); 41298613b67SLisandro Dalcin ierr = MatMFFDSetOptionsPrefix(J,((PetscObject)snes)->prefix);CHKERRQ(ierr); 4139c6ac3b3SBarry Smith ierr = MatSetFromOptions(J);CHKERRQ(ierr); 414aa3661deSLisandro Dalcin } else if (version == 2) { 415e32f2f54SBarry Smith if (!snes->vec_func) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"SNESSetFunction() must be called first"); 41682a7e548SBarry Smith #if !defined(PETSC_USE_COMPLEX) && !defined(PETSC_USE_REAL_SINGLE) && !defined(PETSC_USE_REAL___FLOAT128) 417aa3661deSLisandro Dalcin ierr = SNESDefaultMatrixFreeCreate2(snes,snes->vec_func,&J);CHKERRQ(ierr); 418aa3661deSLisandro Dalcin #else 419e32f2f54SBarry Smith SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP, "matrix-free operator rutines (version 2)"); 420aa3661deSLisandro Dalcin #endif 421a8248277SBarry Smith } else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE, "matrix-free operator rutines, only version 1 and 2"); 422aa3661deSLisandro Dalcin 423aa3661deSLisandro Dalcin ierr = PetscInfo1(snes,"Setting default matrix-free operator routines (version %D)\n", version);CHKERRQ(ierr); 424d3462f78SMatthew Knepley if (hasOperator) { 4253232da50SPeter Brune 426aa3661deSLisandro Dalcin /* This version replaces the user provided Jacobian matrix with a 427aa3661deSLisandro Dalcin matrix-free version but still employs the user-provided preconditioner matrix. */ 428aa3661deSLisandro Dalcin ierr = SNESSetJacobian(snes,J,0,0,0);CHKERRQ(ierr); 429aa3661deSLisandro Dalcin } else { 430aa3661deSLisandro Dalcin /* This version replaces both the user-provided Jacobian and the user- 4313232da50SPeter Brune provided preconditioner Jacobian with the default matrix free version. */ 432172a4300SPeter Brune if ((snes->pcside == PC_LEFT) && snes->pc) { 433d728fb7dSPeter Brune if (!snes->jacobian){ierr = SNESSetJacobian(snes,J,0,0,0);CHKERRQ(ierr);} 434172a4300SPeter Brune } else { 43528a52e04SBarry Smith ierr = SNESSetJacobian(snes,J,J,MatMFFDComputeJacobian,0);CHKERRQ(ierr); 436172a4300SPeter Brune } 437aa3661deSLisandro Dalcin /* Force no preconditioner */ 438aa3661deSLisandro Dalcin ierr = SNESGetKSP(snes,&ksp);CHKERRQ(ierr); 439aa3661deSLisandro Dalcin ierr = KSPGetPC(ksp,&pc);CHKERRQ(ierr); 440251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)pc,PCSHELL,&match);CHKERRQ(ierr); 441aa3661deSLisandro Dalcin if (!match) { 442aa3661deSLisandro Dalcin ierr = PetscInfo(snes,"Setting default matrix-free preconditioner routines\nThat is no preconditioner is being used\n");CHKERRQ(ierr); 443aa3661deSLisandro Dalcin ierr = PCSetType(pc,PCNONE);CHKERRQ(ierr); 444aa3661deSLisandro Dalcin } 445aa3661deSLisandro Dalcin } 4466bf464f9SBarry Smith ierr = MatDestroy(&J);CHKERRQ(ierr); 447aa3661deSLisandro Dalcin PetscFunctionReturn(0); 448aa3661deSLisandro Dalcin } 449aa3661deSLisandro Dalcin 4504a2ae208SSatish Balay #undef __FUNCT__ 451dfe15315SJed Brown #define __FUNCT__ "DMRestrictHook_SNESVecSol" 452dfe15315SJed Brown static PetscErrorCode DMRestrictHook_SNESVecSol(DM dmfine,Mat Restrict,Vec Rscale,Mat Inject,DM dmcoarse,void *ctx) 453dfe15315SJed Brown { 454dfe15315SJed Brown SNES snes = (SNES)ctx; 455dfe15315SJed Brown PetscErrorCode ierr; 4560298fd71SBarry Smith Vec Xfine,Xfine_named = NULL,Xcoarse; 457dfe15315SJed Brown 458dfe15315SJed Brown PetscFunctionBegin; 45916ebb321SJed Brown if (PetscLogPrintInfo) { 46016ebb321SJed Brown PetscInt finelevel,coarselevel,fineclevel,coarseclevel; 46116ebb321SJed Brown ierr = DMGetRefineLevel(dmfine,&finelevel);CHKERRQ(ierr); 46216ebb321SJed Brown ierr = DMGetCoarsenLevel(dmfine,&fineclevel);CHKERRQ(ierr); 46316ebb321SJed Brown ierr = DMGetRefineLevel(dmcoarse,&coarselevel);CHKERRQ(ierr); 46416ebb321SJed Brown ierr = DMGetCoarsenLevel(dmcoarse,&coarseclevel);CHKERRQ(ierr); 46516ebb321SJed Brown ierr = PetscInfo4(dmfine,"Restricting SNES solution vector from level %D-%D to level %D-%D\n",finelevel,fineclevel,coarselevel,coarseclevel);CHKERRQ(ierr); 46616ebb321SJed Brown } 467dfe15315SJed Brown if (dmfine == snes->dm) Xfine = snes->vec_sol; 468dfe15315SJed Brown else { 469dfe15315SJed Brown ierr = DMGetNamedGlobalVector(dmfine,"SNESVecSol",&Xfine_named);CHKERRQ(ierr); 470dfe15315SJed Brown Xfine = Xfine_named; 471dfe15315SJed Brown } 472dfe15315SJed Brown ierr = DMGetNamedGlobalVector(dmcoarse,"SNESVecSol",&Xcoarse);CHKERRQ(ierr); 473dfe15315SJed Brown ierr = MatRestrict(Restrict,Xfine,Xcoarse);CHKERRQ(ierr); 474dfe15315SJed Brown ierr = VecPointwiseMult(Xcoarse,Xcoarse,Rscale);CHKERRQ(ierr); 475dfe15315SJed Brown ierr = DMRestoreNamedGlobalVector(dmcoarse,"SNESVecSol",&Xcoarse);CHKERRQ(ierr); 476dfe15315SJed Brown if (Xfine_named) {ierr = DMRestoreNamedGlobalVector(dmfine,"SNESVecSol",&Xfine_named);CHKERRQ(ierr);} 477dfe15315SJed Brown PetscFunctionReturn(0); 478dfe15315SJed Brown } 479dfe15315SJed Brown 480dfe15315SJed Brown #undef __FUNCT__ 48116ebb321SJed Brown #define __FUNCT__ "DMCoarsenHook_SNESVecSol" 48216ebb321SJed Brown static PetscErrorCode DMCoarsenHook_SNESVecSol(DM dm,DM dmc,void *ctx) 48316ebb321SJed Brown { 48416ebb321SJed Brown PetscErrorCode ierr; 48516ebb321SJed Brown 48616ebb321SJed Brown PetscFunctionBegin; 48716ebb321SJed Brown ierr = DMCoarsenHookAdd(dmc,DMCoarsenHook_SNESVecSol,DMRestrictHook_SNESVecSol,ctx);CHKERRQ(ierr); 48816ebb321SJed Brown PetscFunctionReturn(0); 48916ebb321SJed Brown } 49016ebb321SJed Brown 49116ebb321SJed Brown #undef __FUNCT__ 492caa4e7f2SJed Brown #define __FUNCT__ "KSPComputeOperators_SNES" 493a6950cb2SJed Brown /* This may be called to rediscretize the operator on levels of linear multigrid. The DM shuffle is so the user can 494a6950cb2SJed Brown * safely call SNESGetDM() in their residual evaluation routine. */ 495caa4e7f2SJed Brown static PetscErrorCode KSPComputeOperators_SNES(KSP ksp,Mat A,Mat B,MatStructure *mstruct,void *ctx) 496caa4e7f2SJed Brown { 497caa4e7f2SJed Brown SNES snes = (SNES)ctx; 498caa4e7f2SJed Brown PetscErrorCode ierr; 499caa4e7f2SJed Brown Mat Asave = A,Bsave = B; 5000298fd71SBarry Smith Vec X,Xnamed = NULL; 501dfe15315SJed Brown DM dmsave; 5024e269d77SPeter Brune void *ctxsave; 5034e269d77SPeter Brune PetscErrorCode (*jac)(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 504caa4e7f2SJed Brown 505caa4e7f2SJed Brown PetscFunctionBegin; 506dfe15315SJed Brown dmsave = snes->dm; 507dfe15315SJed Brown ierr = KSPGetDM(ksp,&snes->dm);CHKERRQ(ierr); 508dfe15315SJed Brown if (dmsave == snes->dm) X = snes->vec_sol; /* We are on the finest level */ 509dfe15315SJed Brown else { /* We are on a coarser level, this vec was initialized using a DM restrict hook */ 510dfe15315SJed Brown ierr = DMGetNamedGlobalVector(snes->dm,"SNESVecSol",&Xnamed);CHKERRQ(ierr); 511dfe15315SJed Brown X = Xnamed; 5120298fd71SBarry Smith ierr = SNESGetJacobian(snes,NULL,NULL,&jac,&ctxsave);CHKERRQ(ierr); 5134e269d77SPeter Brune /* If the DM's don't match up, the MatFDColoring context needed for the jacobian won't match up either -- fixit. */ 5148d359177SBarry Smith if (jac == SNESComputeJacobianDefaultColor) { 5158d359177SBarry Smith ierr = SNESSetJacobian(snes,NULL,NULL,SNESComputeJacobianDefaultColor,0);CHKERRQ(ierr); 516dfe15315SJed Brown } 5174e269d77SPeter Brune } 5184e269d77SPeter Brune /* put the previous context back */ 5194e269d77SPeter Brune 520dfe15315SJed Brown ierr = SNESComputeJacobian(snes,X,&A,&B,mstruct);CHKERRQ(ierr); 5218d359177SBarry Smith if (snes->dm != dmsave && jac == SNESComputeJacobianDefaultColor) { 5220298fd71SBarry Smith ierr = SNESSetJacobian(snes,NULL,NULL,jac,ctxsave);CHKERRQ(ierr); 5234e269d77SPeter Brune } 5244e269d77SPeter Brune 525ce94432eSBarry Smith if (A != Asave || B != Bsave) SETERRQ(PetscObjectComm((PetscObject)snes),PETSC_ERR_SUP,"No support for changing matrices at this time"); 526dfe15315SJed Brown if (Xnamed) { 527dfe15315SJed Brown ierr = DMRestoreNamedGlobalVector(snes->dm,"SNESVecSol",&Xnamed);CHKERRQ(ierr); 528dfe15315SJed Brown } 529dfe15315SJed Brown snes->dm = dmsave; 530caa4e7f2SJed Brown PetscFunctionReturn(0); 531caa4e7f2SJed Brown } 532caa4e7f2SJed Brown 533caa4e7f2SJed Brown #undef __FUNCT__ 5346cab3a1bSJed Brown #define __FUNCT__ "SNESSetUpMatrices" 5356cab3a1bSJed Brown /*@ 5366cab3a1bSJed Brown SNESSetUpMatrices - ensures that matrices are available for SNES, to be called by SNESSetUp_XXX() 5376cab3a1bSJed Brown 5386cab3a1bSJed Brown Collective 5396cab3a1bSJed Brown 5406cab3a1bSJed Brown Input Arguments: 5416cab3a1bSJed Brown . snes - snes to configure 5426cab3a1bSJed Brown 5436cab3a1bSJed Brown Level: developer 5446cab3a1bSJed Brown 5456cab3a1bSJed Brown .seealso: SNESSetUp() 5466cab3a1bSJed Brown @*/ 5476cab3a1bSJed Brown PetscErrorCode SNESSetUpMatrices(SNES snes) 5486cab3a1bSJed Brown { 5496cab3a1bSJed Brown PetscErrorCode ierr; 5506cab3a1bSJed Brown DM dm; 551942e3340SBarry Smith DMSNES sdm; 5526cab3a1bSJed Brown 5536cab3a1bSJed Brown PetscFunctionBegin; 5546cab3a1bSJed Brown ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr); 555942e3340SBarry Smith ierr = DMGetDMSNES(dm,&sdm);CHKERRQ(ierr); 556ce94432eSBarry Smith if (!sdm->ops->computejacobian) SETERRQ(PetscObjectComm((PetscObject)snes),PETSC_ERR_PLIB,"DMSNES not properly configured"); 557f5af7f23SKarl Rupp else if (!snes->jacobian && snes->mf) { 5586cab3a1bSJed Brown Mat J; 5596cab3a1bSJed Brown void *functx; 5606cab3a1bSJed Brown ierr = MatCreateSNESMF(snes,&J);CHKERRQ(ierr); 5616cab3a1bSJed Brown ierr = MatMFFDSetOptionsPrefix(J,((PetscObject)snes)->prefix);CHKERRQ(ierr); 5626cab3a1bSJed Brown ierr = MatSetFromOptions(J);CHKERRQ(ierr); 5630298fd71SBarry Smith ierr = SNESGetFunction(snes,NULL,NULL,&functx);CHKERRQ(ierr); 5643232da50SPeter Brune ierr = SNESSetJacobian(snes,J,J,0,0);CHKERRQ(ierr); 5656cab3a1bSJed Brown ierr = MatDestroy(&J);CHKERRQ(ierr); 566caa4e7f2SJed Brown } else if (snes->mf_operator && !snes->jacobian_pre && !snes->jacobian) { 5676cab3a1bSJed Brown Mat J,B; 5686cab3a1bSJed Brown ierr = MatCreateSNESMF(snes,&J);CHKERRQ(ierr); 5696cab3a1bSJed Brown ierr = MatMFFDSetOptionsPrefix(J,((PetscObject)snes)->prefix);CHKERRQ(ierr); 5706cab3a1bSJed Brown ierr = MatSetFromOptions(J);CHKERRQ(ierr); 5716cab3a1bSJed Brown ierr = DMCreateMatrix(snes->dm,MATAIJ,&B);CHKERRQ(ierr); 57206f20277SJed Brown /* sdm->computejacobian was already set to reach here */ 5730298fd71SBarry Smith ierr = SNESSetJacobian(snes,J,B,NULL,NULL);CHKERRQ(ierr); 5746cab3a1bSJed Brown ierr = MatDestroy(&J);CHKERRQ(ierr); 5756cab3a1bSJed Brown ierr = MatDestroy(&B);CHKERRQ(ierr); 576caa4e7f2SJed Brown } else if (!snes->jacobian_pre) { 5776cab3a1bSJed Brown Mat J,B; 5786cab3a1bSJed Brown J = snes->jacobian; 5796cab3a1bSJed Brown ierr = DMCreateMatrix(snes->dm,MATAIJ,&B);CHKERRQ(ierr); 5800298fd71SBarry Smith ierr = SNESSetJacobian(snes,J ? J : B,B,NULL,NULL);CHKERRQ(ierr); 5816cab3a1bSJed Brown ierr = MatDestroy(&B);CHKERRQ(ierr); 5826cab3a1bSJed Brown } 583caa4e7f2SJed Brown { 584caa4e7f2SJed Brown KSP ksp; 585caa4e7f2SJed Brown ierr = SNESGetKSP(snes,&ksp);CHKERRQ(ierr); 586caa4e7f2SJed Brown ierr = KSPSetComputeOperators(ksp,KSPComputeOperators_SNES,snes);CHKERRQ(ierr); 58716ebb321SJed Brown ierr = DMCoarsenHookAdd(snes->dm,DMCoarsenHook_SNESVecSol,DMRestrictHook_SNESVecSol,snes);CHKERRQ(ierr); 588caa4e7f2SJed Brown } 5896cab3a1bSJed Brown PetscFunctionReturn(0); 5906cab3a1bSJed Brown } 5916cab3a1bSJed Brown 5926cab3a1bSJed Brown #undef __FUNCT__ 5934a2ae208SSatish Balay #define __FUNCT__ "SNESSetFromOptions" 5949b94acceSBarry Smith /*@ 59594b7f48cSBarry Smith SNESSetFromOptions - Sets various SNES and KSP parameters from user options. 5969b94acceSBarry Smith 597c7afd0dbSLois Curfman McInnes Collective on SNES 598c7afd0dbSLois Curfman McInnes 5999b94acceSBarry Smith Input Parameter: 6009b94acceSBarry Smith . snes - the SNES context 6019b94acceSBarry Smith 60236851e7fSLois Curfman McInnes Options Database Keys: 603ea630c6eSPeter Brune + -snes_type <type> - ls, tr, ngmres, ncg, richardson, qn, vi, fas 60482738288SBarry Smith . -snes_stol - convergence tolerance in terms of the norm 60582738288SBarry Smith of the change in the solution between steps 60670441072SBarry Smith . -snes_atol <abstol> - absolute tolerance of residual norm 607b39c3a46SLois Curfman McInnes . -snes_rtol <rtol> - relative decrease in tolerance norm from initial 608b39c3a46SLois Curfman McInnes . -snes_max_it <max_it> - maximum number of iterations 609b39c3a46SLois Curfman McInnes . -snes_max_funcs <max_funcs> - maximum number of function evaluations 6104839bfe8SBarry Smith . -snes_max_fail <max_fail> - maximum number of line search failures allowed before stopping, default is none 611ddf469c8SBarry Smith . -snes_max_linear_solve_fail - number of linear solver failures before SNESSolve() stops 612a8054027SBarry Smith . -snes_lag_preconditioner <lag> - how often preconditioner is rebuilt (use -1 to never rebuild) 613e35cf81dSBarry Smith . -snes_lag_jacobian <lag> - how often Jacobian is rebuilt (use -1 to never rebuild) 614b39c3a46SLois Curfman McInnes . -snes_trtol <trtol> - trust region tolerance 6152492ecdbSBarry Smith . -snes_no_convergence_test - skip convergence test in nonlinear 61682738288SBarry Smith solver; hence iterations will continue until max_it 6171fbbfb26SLois Curfman McInnes or some other criterion is reached. Saves expense 61882738288SBarry Smith of convergence test 619e8105e01SRichard Katz . -snes_monitor <optional filename> - prints residual norm at each iteration. if no 620e8105e01SRichard Katz filename given prints to stdout 621a6570f20SBarry Smith . -snes_monitor_solution - plots solution at each iteration 622a6570f20SBarry Smith . -snes_monitor_residual - plots residual (not its norm) at each iteration 623a6570f20SBarry Smith . -snes_monitor_solution_update - plots update to solution at each iteration 6244619e776SBarry Smith . -snes_monitor_lg_residualnorm - plots residual norm at each iteration 625459f5d12SBarry Smith . -snes_monitor_lg_range - plots residual norm at each iteration 626e24b481bSBarry Smith . -snes_fd - use finite differences to compute Jacobian; very slow, only for testing 627e2e60de9SPeter Brune . -snes_fd_color - use finite differences with coloring to compute Jacobian 6285968eb51SBarry Smith . -snes_mf_ksp_monitor - if using matrix-free multiply then print h at each KSP iteration 629fee2055bSBarry Smith - -snes_converged_reason - print the reason for convergence/divergence after each solve 63082738288SBarry Smith 63182738288SBarry Smith Options Database for Eisenstat-Walker method: 632fa9f3622SBarry Smith + -snes_ksp_ew - use Eisenstat-Walker method for determining linear system convergence 6334b27c08aSLois Curfman McInnes . -snes_ksp_ew_version ver - version of Eisenstat-Walker method 63436851e7fSLois Curfman McInnes . -snes_ksp_ew_rtol0 <rtol0> - Sets rtol0 63536851e7fSLois Curfman McInnes . -snes_ksp_ew_rtolmax <rtolmax> - Sets rtolmax 63636851e7fSLois Curfman McInnes . -snes_ksp_ew_gamma <gamma> - Sets gamma 63736851e7fSLois Curfman McInnes . -snes_ksp_ew_alpha <alpha> - Sets alpha 63836851e7fSLois Curfman McInnes . -snes_ksp_ew_alpha2 <alpha2> - Sets alpha2 63936851e7fSLois Curfman McInnes - -snes_ksp_ew_threshold <threshold> - Sets threshold 64082738288SBarry Smith 64111ca99fdSLois Curfman McInnes Notes: 64211ca99fdSLois Curfman McInnes To see all options, run your program with the -help option or consult 6430598bfebSBarry Smith the <A href="../../docs/manual.pdf#nameddest=ch_snes">SNES chapter of the users manual</A>. 64483e2fdc7SBarry Smith 64536851e7fSLois Curfman McInnes Level: beginner 64636851e7fSLois Curfman McInnes 6479b94acceSBarry Smith .keywords: SNES, nonlinear, set, options, database 6489b94acceSBarry Smith 64969ed319cSSatish Balay .seealso: SNESSetOptionsPrefix() 6509b94acceSBarry Smith @*/ 6517087cfbeSBarry Smith PetscErrorCode SNESSetFromOptions(SNES snes) 6529b94acceSBarry Smith { 65337ec4e1aSPeter Brune PetscBool flg,pcset,persist; 654d8f46077SPeter Brune PetscInt i,indx,lag,grids; 655aa3661deSLisandro Dalcin MatStructure matflag; 65604d7464bSBarry Smith const char *deft = SNESNEWTONLS; 65785385478SLisandro Dalcin const char *convtests[] = {"default","skip"}; 65885385478SLisandro Dalcin SNESKSPEW *kctx = NULL; 659e8105e01SRichard Katz char type[256], monfilename[PETSC_MAX_PATH_LEN]; 660649052a6SBarry Smith PetscViewer monviewer; 66185385478SLisandro Dalcin PetscErrorCode ierr; 662c40d0f55SPeter Brune PCSide pcside; 663a64e098fSPeter Brune const char *optionsprefix; 6649b94acceSBarry Smith 6653a40ed3dSBarry Smith PetscFunctionBegin; 6660700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 667607a6623SBarry Smith if (!SNESRegisterAllCalled) {ierr = SNESRegisterAll();CHKERRQ(ierr);} 6683194b578SJed Brown ierr = PetscObjectOptionsBegin((PetscObject)snes);CHKERRQ(ierr); 669639ff905SBarry Smith if (((PetscObject)snes)->type_name) deft = ((PetscObject)snes)->type_name; 670b0a32e0cSBarry Smith ierr = PetscOptionsList("-snes_type","Nonlinear solver method","SNESSetType",SNESList,deft,type,256,&flg);CHKERRQ(ierr); 671d64ed03dSBarry Smith if (flg) { 672186905e3SBarry Smith ierr = SNESSetType(snes,type);CHKERRQ(ierr); 6737adad957SLisandro Dalcin } else if (!((PetscObject)snes)->type_name) { 674186905e3SBarry Smith ierr = SNESSetType(snes,deft);CHKERRQ(ierr); 675d64ed03dSBarry Smith } 67690d69ab7SBarry Smith /* not used here, but called so will go into help messaage */ 677909c8a9fSBarry Smith ierr = PetscOptionsName("-snes_view","Print detailed information on solver used","SNESView",0);CHKERRQ(ierr); 67893c39befSBarry Smith 679c60f73f4SPeter Brune ierr = PetscOptionsReal("-snes_stol","Stop if step length less than","SNESSetTolerances",snes->stol,&snes->stol,0);CHKERRQ(ierr); 68057034d6fSHong Zhang ierr = PetscOptionsReal("-snes_atol","Stop if function norm less than","SNESSetTolerances",snes->abstol,&snes->abstol,0);CHKERRQ(ierr); 681186905e3SBarry Smith 68257034d6fSHong Zhang ierr = PetscOptionsReal("-snes_rtol","Stop if decrease in function norm less than","SNESSetTolerances",snes->rtol,&snes->rtol,0);CHKERRQ(ierr); 6830298fd71SBarry Smith ierr = PetscOptionsInt("-snes_max_it","Maximum iterations","SNESSetTolerances",snes->max_its,&snes->max_its,NULL);CHKERRQ(ierr); 6840298fd71SBarry Smith ierr = PetscOptionsInt("-snes_max_funcs","Maximum function evaluations","SNESSetTolerances",snes->max_funcs,&snes->max_funcs,NULL);CHKERRQ(ierr); 6850298fd71SBarry Smith ierr = PetscOptionsInt("-snes_max_fail","Maximum nonlinear step failures","SNESSetMaxNonlinearStepFailures",snes->maxFailures,&snes->maxFailures,NULL);CHKERRQ(ierr); 6860298fd71SBarry Smith ierr = PetscOptionsInt("-snes_max_linear_solve_fail","Maximum failures in linear solves allowed","SNESSetMaxLinearSolveFailures",snes->maxLinearSolveFailures,&snes->maxLinearSolveFailures,NULL);CHKERRQ(ierr); 6870298fd71SBarry Smith ierr = PetscOptionsBool("-snes_error_if_not_converged","Generate error if solver does not converge","SNESSetErrorIfNotConverged",snes->errorifnotconverged,&snes->errorifnotconverged,NULL);CHKERRQ(ierr); 68885385478SLisandro Dalcin 689a8054027SBarry Smith ierr = PetscOptionsInt("-snes_lag_preconditioner","How often to rebuild preconditioner","SNESSetLagPreconditioner",snes->lagpreconditioner,&lag,&flg);CHKERRQ(ierr); 690a8054027SBarry Smith if (flg) { 691a8054027SBarry Smith ierr = SNESSetLagPreconditioner(snes,lag);CHKERRQ(ierr); 692a8054027SBarry Smith } 69337ec4e1aSPeter Brune ierr = PetscOptionsBool("-snes_lag_preconditioner_persists","Preconditioner lagging through multiple solves","SNESSetLagPreconditionerPersists",snes->lagjac_persist,&persist,&flg);CHKERRQ(ierr); 69437ec4e1aSPeter Brune if (flg) { 69537ec4e1aSPeter Brune ierr = SNESSetLagPreconditionerPersists(snes,persist);CHKERRQ(ierr); 69637ec4e1aSPeter Brune } 697e35cf81dSBarry Smith ierr = PetscOptionsInt("-snes_lag_jacobian","How often to rebuild Jacobian","SNESSetLagJacobian",snes->lagjacobian,&lag,&flg);CHKERRQ(ierr); 698e35cf81dSBarry Smith if (flg) { 699e35cf81dSBarry Smith ierr = SNESSetLagJacobian(snes,lag);CHKERRQ(ierr); 700e35cf81dSBarry Smith } 70137ec4e1aSPeter Brune ierr = PetscOptionsBool("-snes_lag_jacobian_persists","Jacobian lagging through multiple solves","SNESSetLagJacobianPersists",snes->lagjac_persist,&persist,&flg);CHKERRQ(ierr); 70237ec4e1aSPeter Brune if (flg) { 70337ec4e1aSPeter Brune ierr = SNESSetLagJacobianPersists(snes,persist);CHKERRQ(ierr); 70437ec4e1aSPeter Brune } 70537ec4e1aSPeter Brune 706efd51863SBarry Smith ierr = PetscOptionsInt("-snes_grid_sequence","Use grid sequencing to generate initial guess","SNESSetGridSequence",snes->gridsequence,&grids,&flg);CHKERRQ(ierr); 707efd51863SBarry Smith if (flg) { 708efd51863SBarry Smith ierr = SNESSetGridSequence(snes,grids);CHKERRQ(ierr); 709efd51863SBarry Smith } 710a8054027SBarry Smith 71185385478SLisandro Dalcin ierr = PetscOptionsEList("-snes_convergence_test","Convergence test","SNESSetConvergenceTest",convtests,2,"default",&indx,&flg);CHKERRQ(ierr); 71285385478SLisandro Dalcin if (flg) { 71385385478SLisandro Dalcin switch (indx) { 7148d359177SBarry Smith case 0: ierr = SNESSetConvergenceTest(snes,SNESConvergedDefault,NULL,NULL);CHKERRQ(ierr); break; 7150298fd71SBarry Smith case 1: ierr = SNESSetConvergenceTest(snes,SNESSkipConverged,NULL,NULL);CHKERRQ(ierr); break; 71685385478SLisandro Dalcin } 71785385478SLisandro Dalcin } 71885385478SLisandro Dalcin 7190298fd71SBarry Smith ierr = PetscOptionsBool("-snes_converged_reason","Print reason for converged or diverged","SNESSolve",snes->printreason,&snes->printreason,NULL);CHKERRQ(ierr); 720186905e3SBarry Smith 721365a6726SPeter Brune ierr = PetscOptionsEList("-snes_norm_schedule","SNES Norm schedule","SNESSetNormSchedule",SNESNormSchedules,5,"function",&indx,&flg);CHKERRQ(ierr); 722365a6726SPeter Brune if (flg) { ierr = SNESSetNormSchedule(snes,(SNESNormSchedule)indx);CHKERRQ(ierr); } 723fdacfa88SPeter Brune 72447073ea2SPeter Brune ierr = PetscOptionsEList("-snes_function_type","SNES Norm schedule","SNESSetFunctionType",SNESFunctionTypes,2,"unpreconditioned",&indx,&flg);CHKERRQ(ierr); 72547073ea2SPeter Brune if (flg) { ierr = SNESSetFunctionType(snes,(SNESFunctionType)indx);CHKERRQ(ierr); } 726186905e3SBarry Smith 72785385478SLisandro Dalcin kctx = (SNESKSPEW*)snes->kspconvctx; 72885385478SLisandro Dalcin 7290298fd71SBarry Smith ierr = PetscOptionsBool("-snes_ksp_ew","Use Eisentat-Walker linear system convergence test","SNESKSPSetUseEW",snes->ksp_ewconv,&snes->ksp_ewconv,NULL);CHKERRQ(ierr); 730186905e3SBarry Smith 731fa9f3622SBarry Smith ierr = PetscOptionsInt("-snes_ksp_ew_version","Version 1, 2 or 3","SNESKSPSetParametersEW",kctx->version,&kctx->version,0);CHKERRQ(ierr); 732fa9f3622SBarry Smith ierr = PetscOptionsReal("-snes_ksp_ew_rtol0","0 <= rtol0 < 1","SNESKSPSetParametersEW",kctx->rtol_0,&kctx->rtol_0,0);CHKERRQ(ierr); 733fa9f3622SBarry Smith ierr = PetscOptionsReal("-snes_ksp_ew_rtolmax","0 <= rtolmax < 1","SNESKSPSetParametersEW",kctx->rtol_max,&kctx->rtol_max,0);CHKERRQ(ierr); 734fa9f3622SBarry Smith ierr = PetscOptionsReal("-snes_ksp_ew_gamma","0 <= gamma <= 1","SNESKSPSetParametersEW",kctx->gamma,&kctx->gamma,0);CHKERRQ(ierr); 735fa9f3622SBarry Smith ierr = PetscOptionsReal("-snes_ksp_ew_alpha","1 < alpha <= 2","SNESKSPSetParametersEW",kctx->alpha,&kctx->alpha,0);CHKERRQ(ierr); 736fa9f3622SBarry Smith ierr = PetscOptionsReal("-snes_ksp_ew_alpha2","alpha2","SNESKSPSetParametersEW",kctx->alpha2,&kctx->alpha2,0);CHKERRQ(ierr); 737fa9f3622SBarry Smith ierr = PetscOptionsReal("-snes_ksp_ew_threshold","0 < threshold < 1","SNESKSPSetParametersEW",kctx->threshold,&kctx->threshold,0);CHKERRQ(ierr); 738186905e3SBarry Smith 73990d69ab7SBarry Smith flg = PETSC_FALSE; 7400298fd71SBarry Smith ierr = PetscOptionsBool("-snes_check_jacobian","Check each Jacobian with a differenced one","SNESUpdateCheckJacobian",flg,&flg,NULL);CHKERRQ(ierr); 7415341784dSBarry Smith if (flg) { 7425341784dSBarry Smith ierr = SNESSetUpdate(snes,SNESUpdateCheckJacobian);CHKERRQ(ierr); 7435341784dSBarry Smith } 7445341784dSBarry Smith 7455341784dSBarry Smith flg = PETSC_FALSE; 7460298fd71SBarry Smith ierr = PetscOptionsBool("-snes_monitor_cancel","Remove all monitors","SNESMonitorCancel",flg,&flg,NULL);CHKERRQ(ierr); 747a6570f20SBarry Smith if (flg) {ierr = SNESMonitorCancel(snes);CHKERRQ(ierr);} 748eabae89aSBarry Smith 749a6570f20SBarry Smith ierr = PetscOptionsString("-snes_monitor","Monitor norm of function","SNESMonitorSet","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 750e8105e01SRichard Katz if (flg) { 751ce94432eSBarry Smith ierr = PetscViewerASCIIOpen(PetscObjectComm((PetscObject)snes),monfilename,&monviewer);CHKERRQ(ierr); 752649052a6SBarry Smith ierr = SNESMonitorSet(snes,SNESMonitorDefault,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr); 753e8105e01SRichard Katz } 754eabae89aSBarry Smith 755b271bb04SBarry Smith ierr = PetscOptionsString("-snes_monitor_range","Monitor range of elements of function","SNESMonitorSet","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 756b271bb04SBarry Smith if (flg) { 757b271bb04SBarry Smith ierr = SNESMonitorSet(snes,SNESMonitorRange,0,0);CHKERRQ(ierr); 758b271bb04SBarry Smith } 759b271bb04SBarry Smith 760a6570f20SBarry Smith ierr = PetscOptionsString("-snes_ratiomonitor","Monitor ratios of norms of function","SNESMonitorSetRatio","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 761eabae89aSBarry Smith if (flg) { 762ce94432eSBarry Smith ierr = PetscViewerASCIIOpen(PetscObjectComm((PetscObject)snes),monfilename,&monviewer);CHKERRQ(ierr); 763f1bef1bcSMatthew Knepley ierr = SNESMonitorSetRatio(snes,monviewer);CHKERRQ(ierr); 764e8105e01SRichard Katz } 765eabae89aSBarry Smith 766a6570f20SBarry Smith ierr = PetscOptionsString("-snes_monitor_short","Monitor norm of function (fewer digits)","SNESMonitorSet","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 767eabae89aSBarry Smith if (flg) { 768ce94432eSBarry Smith ierr = PetscViewerASCIIOpen(PetscObjectComm((PetscObject)snes),monfilename,&monviewer);CHKERRQ(ierr); 769649052a6SBarry Smith ierr = SNESMonitorSet(snes,SNESMonitorDefaultShort,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr); 770eabae89aSBarry Smith } 771eabae89aSBarry Smith 7725180491cSLisandro Dalcin ierr = PetscOptionsString("-snes_monitor_python","Use Python function","SNESMonitorSet",0,monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 7735180491cSLisandro Dalcin if (flg) {ierr = PetscPythonMonitorSet((PetscObject)snes,monfilename);CHKERRQ(ierr);} 7745180491cSLisandro Dalcin 77590d69ab7SBarry Smith flg = PETSC_FALSE; 7760298fd71SBarry Smith ierr = PetscOptionsBool("-snes_monitor_solution","Plot solution at each iteration","SNESMonitorSolution",flg,&flg,NULL);CHKERRQ(ierr); 777a6570f20SBarry Smith if (flg) {ierr = SNESMonitorSet(snes,SNESMonitorSolution,0,0);CHKERRQ(ierr);} 77890d69ab7SBarry Smith flg = PETSC_FALSE; 7790298fd71SBarry Smith ierr = PetscOptionsBool("-snes_monitor_solution_update","Plot correction at each iteration","SNESMonitorSolutionUpdate",flg,&flg,NULL);CHKERRQ(ierr); 780a6570f20SBarry Smith if (flg) {ierr = SNESMonitorSet(snes,SNESMonitorSolutionUpdate,0,0);CHKERRQ(ierr);} 78190d69ab7SBarry Smith flg = PETSC_FALSE; 7820298fd71SBarry Smith ierr = PetscOptionsBool("-snes_monitor_residual","Plot residual at each iteration","SNESMonitorResidual",flg,&flg,NULL);CHKERRQ(ierr); 783a6570f20SBarry Smith if (flg) {ierr = SNESMonitorSet(snes,SNESMonitorResidual,0,0);CHKERRQ(ierr);} 78490d69ab7SBarry Smith flg = PETSC_FALSE; 7850298fd71SBarry Smith ierr = PetscOptionsBool("-snes_monitor_lg_residualnorm","Plot function norm at each iteration","SNESMonitorLGResidualNorm",flg,&flg,NULL);CHKERRQ(ierr); 786459f5d12SBarry Smith if (flg) { 787459f5d12SBarry Smith PetscDrawLG ctx; 788459f5d12SBarry Smith 789459f5d12SBarry Smith ierr = SNESMonitorLGCreate(0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,&ctx);CHKERRQ(ierr); 790459f5d12SBarry Smith ierr = SNESMonitorSet(snes,SNESMonitorLGResidualNorm,ctx,(PetscErrorCode (*)(void**))SNESMonitorLGDestroy);CHKERRQ(ierr); 791459f5d12SBarry Smith } 79290d69ab7SBarry Smith flg = PETSC_FALSE; 7930298fd71SBarry Smith ierr = PetscOptionsBool("-snes_monitor_lg_range","Plot function range at each iteration","SNESMonitorLGRange",flg,&flg,NULL);CHKERRQ(ierr); 794459f5d12SBarry Smith if (flg) { 795459f5d12SBarry Smith PetscViewer ctx; 796e24b481bSBarry Smith 797ce94432eSBarry Smith ierr = PetscViewerDrawOpen(PetscObjectComm((PetscObject)snes),0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,&ctx);CHKERRQ(ierr); 798459f5d12SBarry Smith ierr = SNESMonitorSet(snes,SNESMonitorLGRange,ctx,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr); 799459f5d12SBarry Smith } 8002e7541e6SPeter Brune 8012e7541e6SPeter Brune flg = PETSC_FALSE; 8020298fd71SBarry Smith ierr = PetscOptionsBool("-snes_monitor_jacupdate_spectrum","Print the change in the spectrum of the Jacobian","SNESMonitorJacUpdateSpectrum",flg,&flg,NULL);CHKERRQ(ierr); 8032e7541e6SPeter Brune if (flg) {ierr = SNESMonitorSet(snes,SNESMonitorJacUpdateSpectrum,0,0);CHKERRQ(ierr);} 8042e7541e6SPeter Brune 80590d69ab7SBarry Smith flg = PETSC_FALSE; 8068d359177SBarry Smith ierr = PetscOptionsBool("-snes_fd","Use finite differences (slow) to compute Jacobian","SNESComputeJacobianDefault",flg,&flg,NULL);CHKERRQ(ierr); 8074b27c08aSLois Curfman McInnes if (flg) { 8086cab3a1bSJed Brown void *functx; 8090298fd71SBarry Smith ierr = SNESGetFunction(snes,NULL,NULL,&functx);CHKERRQ(ierr); 8108d359177SBarry Smith ierr = SNESSetJacobian(snes,snes->jacobian,snes->jacobian_pre,SNESComputeJacobianDefault,functx);CHKERRQ(ierr); 811ae15b995SBarry Smith ierr = PetscInfo(snes,"Setting default finite difference Jacobian matrix\n");CHKERRQ(ierr); 8129b94acceSBarry Smith } 813639f9d9dSBarry Smith 81444848bc4SPeter Brune flg = PETSC_FALSE; 8158d359177SBarry Smith ierr = PetscOptionsBool("-snes_fd_function","Use finite differences (slow) to compute function from user objective","SNESObjectiveComputeFunctionDefaultFD",flg,&flg,NULL);CHKERRQ(ierr); 81697584545SPeter Brune if (flg) { 8178d359177SBarry Smith ierr = SNESSetFunction(snes,NULL,SNESObjectiveComputeFunctionDefaultFD,NULL);CHKERRQ(ierr); 81897584545SPeter Brune } 81997584545SPeter Brune 82097584545SPeter Brune flg = PETSC_FALSE; 8218d359177SBarry Smith ierr = PetscOptionsBool("-snes_fd_color","Use finite differences with coloring to compute Jacobian","SNESComputeJacobianDefaultColor",flg,&flg,NULL);CHKERRQ(ierr); 82244848bc4SPeter Brune if (flg) { 823c52e227fSPeter Brune DM dm; 824c52e227fSPeter Brune DMSNES sdm; 825c52e227fSPeter Brune ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr); 826aace71b7SPeter Brune ierr = DMGetDMSNES(dm,&sdm);CHKERRQ(ierr); 827aace71b7SPeter Brune sdm->jacobianctx = NULL; 8288d359177SBarry Smith ierr = SNESSetJacobian(snes,snes->jacobian,snes->jacobian_pre,SNESComputeJacobianDefaultColor,0);CHKERRQ(ierr); 82944848bc4SPeter Brune ierr = PetscInfo(snes,"Setting default finite difference coloring Jacobian matrix\n");CHKERRQ(ierr); 83044848bc4SPeter Brune } 83144848bc4SPeter Brune 832aa3661deSLisandro Dalcin flg = PETSC_FALSE; 833d8f46077SPeter 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); 834d8f46077SPeter Brune if (flg && snes->mf_operator) { 835a8248277SBarry Smith snes->mf_operator = PETSC_TRUE; 836d8f46077SPeter Brune snes->mf = PETSC_TRUE; 837a8248277SBarry Smith } 838aa3661deSLisandro Dalcin flg = PETSC_FALSE; 839d8f46077SPeter Brune ierr = PetscOptionsBool("-snes_mf","Use a Matrix-Free Jacobian with no preconditioner matrix","MatCreateSNESMF",PETSC_FALSE,&snes->mf,&flg);CHKERRQ(ierr); 840d8f46077SPeter Brune if (!flg && snes->mf_operator) snes->mf = PETSC_TRUE; 841d8f46077SPeter Brune ierr = PetscOptionsInt("-snes_mf_version","Matrix-Free routines version 1 or 2","None",snes->mf_version,&snes->mf_version,0);CHKERRQ(ierr); 842d28543b3SPeter Brune 843c40d0f55SPeter Brune flg = PETSC_FALSE; 84422d28d08SBarry Smith ierr = SNESGetPCSide(snes,&pcside);CHKERRQ(ierr); 845c40d0f55SPeter Brune ierr = PetscOptionsEnum("-snes_npc_side","SNES nonlinear preconditioner side","SNESSetPCSide",PCSides,(PetscEnum)pcside,(PetscEnum*)&pcside,&flg);CHKERRQ(ierr); 846c40d0f55SPeter Brune if (flg) {ierr = SNESSetPCSide(snes,pcside);CHKERRQ(ierr);} 847c40d0f55SPeter Brune 848b90c6cbeSBarry Smith #if defined(PETSC_HAVE_AMS) 849b90c6cbeSBarry Smith { 850b90c6cbeSBarry Smith PetscBool set; 851b90c6cbeSBarry Smith flg = PETSC_FALSE; 852b90c6cbeSBarry Smith ierr = PetscOptionsBool("-snes_ams_block","Block for AMS memory snooper at end of SNESSolve","PetscObjectAMSBlock",((PetscObject)snes)->amspublishblock,&flg,&set);CHKERRQ(ierr); 853b90c6cbeSBarry Smith if (set) { 854b90c6cbeSBarry Smith ierr = PetscObjectAMSSetBlock((PetscObject)snes,flg);CHKERRQ(ierr); 855b90c6cbeSBarry Smith } 856b90c6cbeSBarry Smith } 857b90c6cbeSBarry Smith #endif 858b90c6cbeSBarry Smith 85976b2cf59SMatthew Knepley for (i = 0; i < numberofsetfromoptions; i++) { 86076b2cf59SMatthew Knepley ierr = (*othersetfromoptions[i])(snes);CHKERRQ(ierr); 86176b2cf59SMatthew Knepley } 86276b2cf59SMatthew Knepley 863e7788613SBarry Smith if (snes->ops->setfromoptions) { 864e7788613SBarry Smith ierr = (*snes->ops->setfromoptions)(snes);CHKERRQ(ierr); 865639f9d9dSBarry Smith } 8665d973c19SBarry Smith 8675d973c19SBarry Smith /* process any options handlers added with PetscObjectAddOptionsHandler() */ 8685d973c19SBarry Smith ierr = PetscObjectProcessOptionsHandlers((PetscObject)snes);CHKERRQ(ierr); 869b0a32e0cSBarry Smith ierr = PetscOptionsEnd();CHKERRQ(ierr); 8704bbc92c1SBarry Smith 8711cee3971SBarry Smith if (!snes->ksp) {ierr = SNESGetKSP(snes,&snes->ksp);CHKERRQ(ierr);} 8720298fd71SBarry Smith ierr = KSPGetOperators(snes->ksp,NULL,NULL,&matflag);CHKERRQ(ierr); 873aa3661deSLisandro Dalcin ierr = KSPSetOperators(snes->ksp,snes->jacobian,snes->jacobian_pre,matflag);CHKERRQ(ierr); 87485385478SLisandro Dalcin ierr = KSPSetFromOptions(snes->ksp);CHKERRQ(ierr); 87593993e2dSLois Curfman McInnes 8769e764e56SPeter Brune if (!snes->linesearch) { 8777601faf0SJed Brown ierr = SNESGetLineSearch(snes, &snes->linesearch);CHKERRQ(ierr); 8789e764e56SPeter Brune } 879f1c6b773SPeter Brune ierr = SNESLineSearchSetFromOptions(snes->linesearch);CHKERRQ(ierr); 8809e764e56SPeter Brune 88151e86f29SPeter Brune /* if someone has set the SNES PC type, create it. */ 88251e86f29SPeter Brune ierr = SNESGetOptionsPrefix(snes, &optionsprefix);CHKERRQ(ierr); 88351e86f29SPeter Brune ierr = PetscOptionsHasName(optionsprefix, "-npc_snes_type", &pcset);CHKERRQ(ierr); 88451e86f29SPeter Brune if (pcset && (!snes->pc)) { 88551e86f29SPeter Brune ierr = SNESGetPC(snes, &snes->pc);CHKERRQ(ierr); 88651e86f29SPeter Brune } 8873a40ed3dSBarry Smith PetscFunctionReturn(0); 8889b94acceSBarry Smith } 8899b94acceSBarry Smith 890d25893d9SBarry Smith #undef __FUNCT__ 891d25893d9SBarry Smith #define __FUNCT__ "SNESSetComputeApplicationContext" 892bb9467b5SJed Brown /*@C 893d25893d9SBarry Smith SNESSetComputeApplicationContext - Sets an optional function to compute a user-defined context for 894d25893d9SBarry Smith the nonlinear solvers. 895d25893d9SBarry Smith 896d25893d9SBarry Smith Logically Collective on SNES 897d25893d9SBarry Smith 898d25893d9SBarry Smith Input Parameters: 899d25893d9SBarry Smith + snes - the SNES context 900d25893d9SBarry Smith . compute - function to compute the context 901d25893d9SBarry Smith - destroy - function to destroy the context 902d25893d9SBarry Smith 903d25893d9SBarry Smith Level: intermediate 904d25893d9SBarry Smith 905bb9467b5SJed Brown Notes: 906bb9467b5SJed Brown This function is currently not available from Fortran. 907bb9467b5SJed Brown 908d25893d9SBarry Smith .keywords: SNES, nonlinear, set, application, context 909d25893d9SBarry Smith 910d25893d9SBarry Smith .seealso: SNESGetApplicationContext(), SNESSetComputeApplicationContext(), SNESGetApplicationContext() 911d25893d9SBarry Smith @*/ 912d25893d9SBarry Smith PetscErrorCode SNESSetComputeApplicationContext(SNES snes,PetscErrorCode (*compute)(SNES,void**),PetscErrorCode (*destroy)(void**)) 913d25893d9SBarry Smith { 914d25893d9SBarry Smith PetscFunctionBegin; 915d25893d9SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 916d25893d9SBarry Smith snes->ops->usercompute = compute; 917d25893d9SBarry Smith snes->ops->userdestroy = destroy; 918d25893d9SBarry Smith PetscFunctionReturn(0); 919d25893d9SBarry Smith } 920a847f771SSatish Balay 9214a2ae208SSatish Balay #undef __FUNCT__ 9224a2ae208SSatish Balay #define __FUNCT__ "SNESSetApplicationContext" 923b07ff414SBarry Smith /*@ 9249b94acceSBarry Smith SNESSetApplicationContext - Sets the optional user-defined context for 9259b94acceSBarry Smith the nonlinear solvers. 9269b94acceSBarry Smith 9273f9fe445SBarry Smith Logically Collective on SNES 928fee21e36SBarry Smith 929c7afd0dbSLois Curfman McInnes Input Parameters: 930c7afd0dbSLois Curfman McInnes + snes - the SNES context 931c7afd0dbSLois Curfman McInnes - usrP - optional user context 932c7afd0dbSLois Curfman McInnes 93336851e7fSLois Curfman McInnes Level: intermediate 93436851e7fSLois Curfman McInnes 9359b94acceSBarry Smith .keywords: SNES, nonlinear, set, application, context 9369b94acceSBarry Smith 937ecaffddaSVictor Eijkhout .seealso: SNESGetApplicationContext() 9389b94acceSBarry Smith @*/ 9397087cfbeSBarry Smith PetscErrorCode SNESSetApplicationContext(SNES snes,void *usrP) 9409b94acceSBarry Smith { 9411b2093e4SBarry Smith PetscErrorCode ierr; 942b07ff414SBarry Smith KSP ksp; 9431b2093e4SBarry Smith 9443a40ed3dSBarry Smith PetscFunctionBegin; 9450700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 946b07ff414SBarry Smith ierr = SNESGetKSP(snes,&ksp);CHKERRQ(ierr); 947b07ff414SBarry Smith ierr = KSPSetApplicationContext(ksp,usrP);CHKERRQ(ierr); 9489b94acceSBarry Smith snes->user = usrP; 9493a40ed3dSBarry Smith PetscFunctionReturn(0); 9509b94acceSBarry Smith } 95174679c65SBarry Smith 9524a2ae208SSatish Balay #undef __FUNCT__ 9534a2ae208SSatish Balay #define __FUNCT__ "SNESGetApplicationContext" 954b07ff414SBarry Smith /*@ 9559b94acceSBarry Smith SNESGetApplicationContext - Gets the user-defined context for the 9569b94acceSBarry Smith nonlinear solvers. 9579b94acceSBarry Smith 958c7afd0dbSLois Curfman McInnes Not Collective 959c7afd0dbSLois Curfman McInnes 9609b94acceSBarry Smith Input Parameter: 9619b94acceSBarry Smith . snes - SNES context 9629b94acceSBarry Smith 9639b94acceSBarry Smith Output Parameter: 9649b94acceSBarry Smith . usrP - user context 9659b94acceSBarry Smith 96636851e7fSLois Curfman McInnes Level: intermediate 96736851e7fSLois Curfman McInnes 9689b94acceSBarry Smith .keywords: SNES, nonlinear, get, application, context 9699b94acceSBarry Smith 9709b94acceSBarry Smith .seealso: SNESSetApplicationContext() 9719b94acceSBarry Smith @*/ 972e71120c6SJed Brown PetscErrorCode SNESGetApplicationContext(SNES snes,void *usrP) 9739b94acceSBarry Smith { 9743a40ed3dSBarry Smith PetscFunctionBegin; 9750700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 976e71120c6SJed Brown *(void**)usrP = snes->user; 9773a40ed3dSBarry Smith PetscFunctionReturn(0); 9789b94acceSBarry Smith } 97974679c65SBarry Smith 9804a2ae208SSatish Balay #undef __FUNCT__ 9814a2ae208SSatish Balay #define __FUNCT__ "SNESGetIterationNumber" 9829b94acceSBarry Smith /*@ 983c8228a4eSBarry Smith SNESGetIterationNumber - Gets the number of nonlinear iterations completed 984c8228a4eSBarry Smith at this time. 9859b94acceSBarry Smith 986c7afd0dbSLois Curfman McInnes Not Collective 987c7afd0dbSLois Curfman McInnes 9889b94acceSBarry Smith Input Parameter: 9899b94acceSBarry Smith . snes - SNES context 9909b94acceSBarry Smith 9919b94acceSBarry Smith Output Parameter: 9929b94acceSBarry Smith . iter - iteration number 9939b94acceSBarry Smith 994c8228a4eSBarry Smith Notes: 995c8228a4eSBarry Smith For example, during the computation of iteration 2 this would return 1. 996c8228a4eSBarry Smith 997c8228a4eSBarry Smith This is useful for using lagged Jacobians (where one does not recompute the 99808405cd6SLois Curfman McInnes Jacobian at each SNES iteration). For example, the code 99908405cd6SLois Curfman McInnes .vb 100008405cd6SLois Curfman McInnes ierr = SNESGetIterationNumber(snes,&it); 100108405cd6SLois Curfman McInnes if (!(it % 2)) { 100208405cd6SLois Curfman McInnes [compute Jacobian here] 100308405cd6SLois Curfman McInnes } 100408405cd6SLois Curfman McInnes .ve 1005c8228a4eSBarry Smith can be used in your ComputeJacobian() function to cause the Jacobian to be 100608405cd6SLois Curfman McInnes recomputed every second SNES iteration. 1007c8228a4eSBarry Smith 100836851e7fSLois Curfman McInnes Level: intermediate 100936851e7fSLois Curfman McInnes 10102b668275SBarry Smith .keywords: SNES, nonlinear, get, iteration, number, 10112b668275SBarry Smith 1012b850b91aSLisandro Dalcin .seealso: SNESGetFunctionNorm(), SNESGetLinearSolveIterations() 10139b94acceSBarry Smith @*/ 10147087cfbeSBarry Smith PetscErrorCode SNESGetIterationNumber(SNES snes,PetscInt *iter) 10159b94acceSBarry Smith { 10163a40ed3dSBarry Smith PetscFunctionBegin; 10170700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 10184482741eSBarry Smith PetscValidIntPointer(iter,2); 10199b94acceSBarry Smith *iter = snes->iter; 10203a40ed3dSBarry Smith PetscFunctionReturn(0); 10219b94acceSBarry Smith } 102274679c65SBarry Smith 10234a2ae208SSatish Balay #undef __FUNCT__ 1024360c497dSPeter Brune #define __FUNCT__ "SNESSetIterationNumber" 1025360c497dSPeter Brune /*@ 1026360c497dSPeter Brune SNESSetIterationNumber - Sets the current iteration number. 1027360c497dSPeter Brune 1028360c497dSPeter Brune Not Collective 1029360c497dSPeter Brune 1030360c497dSPeter Brune Input Parameter: 1031360c497dSPeter Brune . snes - SNES context 1032360c497dSPeter Brune . iter - iteration number 1033360c497dSPeter Brune 1034360c497dSPeter Brune Level: developer 1035360c497dSPeter Brune 1036360c497dSPeter Brune .keywords: SNES, nonlinear, set, iteration, number, 1037360c497dSPeter Brune 1038360c497dSPeter Brune .seealso: SNESGetFunctionNorm(), SNESGetLinearSolveIterations() 1039360c497dSPeter Brune @*/ 1040360c497dSPeter Brune PetscErrorCode SNESSetIterationNumber(SNES snes,PetscInt iter) 1041360c497dSPeter Brune { 1042360c497dSPeter Brune PetscErrorCode ierr; 1043360c497dSPeter Brune 1044360c497dSPeter Brune PetscFunctionBegin; 1045360c497dSPeter Brune PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 1046ce8c27fbSBarry Smith ierr = PetscObjectAMSTakeAccess((PetscObject)snes);CHKERRQ(ierr); 1047360c497dSPeter Brune snes->iter = iter; 1048ce8c27fbSBarry Smith ierr = PetscObjectAMSGrantAccess((PetscObject)snes);CHKERRQ(ierr); 1049360c497dSPeter Brune PetscFunctionReturn(0); 1050360c497dSPeter Brune } 1051360c497dSPeter Brune 1052360c497dSPeter Brune #undef __FUNCT__ 10534a2ae208SSatish Balay #define __FUNCT__ "SNESGetFunctionNorm" 10549b94acceSBarry Smith /*@ 10559b94acceSBarry Smith SNESGetFunctionNorm - Gets the norm of the current function that was set 10569b94acceSBarry Smith with SNESSSetFunction(). 10579b94acceSBarry Smith 1058c7afd0dbSLois Curfman McInnes Collective on SNES 1059c7afd0dbSLois Curfman McInnes 10609b94acceSBarry Smith Input Parameter: 10619b94acceSBarry Smith . snes - SNES context 10629b94acceSBarry Smith 10639b94acceSBarry Smith Output Parameter: 10649b94acceSBarry Smith . fnorm - 2-norm of function 10659b94acceSBarry Smith 106636851e7fSLois Curfman McInnes Level: intermediate 106736851e7fSLois Curfman McInnes 10689b94acceSBarry Smith .keywords: SNES, nonlinear, get, function, norm 1069a86d99e1SLois Curfman McInnes 1070b850b91aSLisandro Dalcin .seealso: SNESGetFunction(), SNESGetIterationNumber(), SNESGetLinearSolveIterations() 10719b94acceSBarry Smith @*/ 10727087cfbeSBarry Smith PetscErrorCode SNESGetFunctionNorm(SNES snes,PetscReal *fnorm) 10739b94acceSBarry Smith { 10743a40ed3dSBarry Smith PetscFunctionBegin; 10750700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 10764482741eSBarry Smith PetscValidScalarPointer(fnorm,2); 10779b94acceSBarry Smith *fnorm = snes->norm; 10783a40ed3dSBarry Smith PetscFunctionReturn(0); 10799b94acceSBarry Smith } 108074679c65SBarry Smith 1081360c497dSPeter Brune 1082360c497dSPeter Brune #undef __FUNCT__ 1083360c497dSPeter Brune #define __FUNCT__ "SNESSetFunctionNorm" 1084360c497dSPeter Brune /*@ 1085360c497dSPeter Brune SNESSetFunctionNorm - Sets the 2-norm of the current function computed using VecNorm(). 1086360c497dSPeter Brune 1087360c497dSPeter Brune Collective on SNES 1088360c497dSPeter Brune 1089360c497dSPeter Brune Input Parameter: 1090360c497dSPeter Brune . snes - SNES context 1091360c497dSPeter Brune . fnorm - 2-norm of function 1092360c497dSPeter Brune 1093360c497dSPeter Brune Level: developer 1094360c497dSPeter Brune 1095360c497dSPeter Brune .keywords: SNES, nonlinear, set, function, norm 1096360c497dSPeter Brune 1097360c497dSPeter Brune .seealso: SNESSetFunction(), SNESSetIterationNumber(), VecNorm(). 1098360c497dSPeter Brune @*/ 1099360c497dSPeter Brune PetscErrorCode SNESSetFunctionNorm(SNES snes,PetscReal fnorm) 1100360c497dSPeter Brune { 1101360c497dSPeter Brune 1102360c497dSPeter Brune PetscErrorCode ierr; 1103360c497dSPeter Brune 1104360c497dSPeter Brune PetscFunctionBegin; 1105360c497dSPeter Brune PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 1106ce8c27fbSBarry Smith ierr = PetscObjectAMSTakeAccess((PetscObject)snes);CHKERRQ(ierr); 1107360c497dSPeter Brune snes->norm = fnorm; 1108ce8c27fbSBarry Smith ierr = PetscObjectAMSGrantAccess((PetscObject)snes);CHKERRQ(ierr); 1109360c497dSPeter Brune PetscFunctionReturn(0); 1110360c497dSPeter Brune } 1111360c497dSPeter Brune 11124a2ae208SSatish Balay #undef __FUNCT__ 1113b850b91aSLisandro Dalcin #define __FUNCT__ "SNESGetNonlinearStepFailures" 11149b94acceSBarry Smith /*@ 1115b850b91aSLisandro Dalcin SNESGetNonlinearStepFailures - Gets the number of unsuccessful steps 11169b94acceSBarry Smith attempted by the nonlinear solver. 11179b94acceSBarry Smith 1118c7afd0dbSLois Curfman McInnes Not Collective 1119c7afd0dbSLois Curfman McInnes 11209b94acceSBarry Smith Input Parameter: 11219b94acceSBarry Smith . snes - SNES context 11229b94acceSBarry Smith 11239b94acceSBarry Smith Output Parameter: 11249b94acceSBarry Smith . nfails - number of unsuccessful steps attempted 11259b94acceSBarry Smith 1126c96a6f78SLois Curfman McInnes Notes: 1127c96a6f78SLois Curfman McInnes This counter is reset to zero for each successive call to SNESSolve(). 1128c96a6f78SLois Curfman McInnes 112936851e7fSLois Curfman McInnes Level: intermediate 113036851e7fSLois Curfman McInnes 11319b94acceSBarry Smith .keywords: SNES, nonlinear, get, number, unsuccessful, steps 113258ebbce7SBarry Smith 1133e1c61ce8SBarry Smith .seealso: SNESGetMaxLinearSolveFailures(), SNESGetLinearSolveIterations(), SNESSetMaxLinearSolveFailures(), SNESGetLinearSolveFailures(), 113458ebbce7SBarry Smith SNESSetMaxNonlinearStepFailures(), SNESGetMaxNonlinearStepFailures() 11359b94acceSBarry Smith @*/ 11367087cfbeSBarry Smith PetscErrorCode SNESGetNonlinearStepFailures(SNES snes,PetscInt *nfails) 11379b94acceSBarry Smith { 11383a40ed3dSBarry Smith PetscFunctionBegin; 11390700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 11404482741eSBarry Smith PetscValidIntPointer(nfails,2); 114150ffb88aSMatthew Knepley *nfails = snes->numFailures; 114250ffb88aSMatthew Knepley PetscFunctionReturn(0); 114350ffb88aSMatthew Knepley } 114450ffb88aSMatthew Knepley 114550ffb88aSMatthew Knepley #undef __FUNCT__ 1146b850b91aSLisandro Dalcin #define __FUNCT__ "SNESSetMaxNonlinearStepFailures" 114750ffb88aSMatthew Knepley /*@ 1148b850b91aSLisandro Dalcin SNESSetMaxNonlinearStepFailures - Sets the maximum number of unsuccessful steps 114950ffb88aSMatthew Knepley attempted by the nonlinear solver before it gives up. 115050ffb88aSMatthew Knepley 115150ffb88aSMatthew Knepley Not Collective 115250ffb88aSMatthew Knepley 115350ffb88aSMatthew Knepley Input Parameters: 115450ffb88aSMatthew Knepley + snes - SNES context 115550ffb88aSMatthew Knepley - maxFails - maximum of unsuccessful steps 115650ffb88aSMatthew Knepley 115750ffb88aSMatthew Knepley Level: intermediate 115850ffb88aSMatthew Knepley 115950ffb88aSMatthew Knepley .keywords: SNES, nonlinear, set, maximum, unsuccessful, steps 116058ebbce7SBarry Smith 1161e1c61ce8SBarry Smith .seealso: SNESGetMaxLinearSolveFailures(), SNESGetLinearSolveIterations(), SNESSetMaxLinearSolveFailures(), SNESGetLinearSolveFailures(), 116258ebbce7SBarry Smith SNESGetMaxNonlinearStepFailures(), SNESGetNonlinearStepFailures() 116350ffb88aSMatthew Knepley @*/ 11647087cfbeSBarry Smith PetscErrorCode SNESSetMaxNonlinearStepFailures(SNES snes, PetscInt maxFails) 116550ffb88aSMatthew Knepley { 116650ffb88aSMatthew Knepley PetscFunctionBegin; 11670700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 116850ffb88aSMatthew Knepley snes->maxFailures = maxFails; 116950ffb88aSMatthew Knepley PetscFunctionReturn(0); 117050ffb88aSMatthew Knepley } 117150ffb88aSMatthew Knepley 117250ffb88aSMatthew Knepley #undef __FUNCT__ 1173b850b91aSLisandro Dalcin #define __FUNCT__ "SNESGetMaxNonlinearStepFailures" 117450ffb88aSMatthew Knepley /*@ 1175b850b91aSLisandro Dalcin SNESGetMaxNonlinearStepFailures - Gets the maximum number of unsuccessful steps 117650ffb88aSMatthew Knepley attempted by the nonlinear solver before it gives up. 117750ffb88aSMatthew Knepley 117850ffb88aSMatthew Knepley Not Collective 117950ffb88aSMatthew Knepley 118050ffb88aSMatthew Knepley Input Parameter: 118150ffb88aSMatthew Knepley . snes - SNES context 118250ffb88aSMatthew Knepley 118350ffb88aSMatthew Knepley Output Parameter: 118450ffb88aSMatthew Knepley . maxFails - maximum of unsuccessful steps 118550ffb88aSMatthew Knepley 118650ffb88aSMatthew Knepley Level: intermediate 118750ffb88aSMatthew Knepley 118850ffb88aSMatthew Knepley .keywords: SNES, nonlinear, get, maximum, unsuccessful, steps 118958ebbce7SBarry Smith 1190e1c61ce8SBarry Smith .seealso: SNESGetMaxLinearSolveFailures(), SNESGetLinearSolveIterations(), SNESSetMaxLinearSolveFailures(), SNESGetLinearSolveFailures(), 119158ebbce7SBarry Smith SNESSetMaxNonlinearStepFailures(), SNESGetNonlinearStepFailures() 119258ebbce7SBarry Smith 119350ffb88aSMatthew Knepley @*/ 11947087cfbeSBarry Smith PetscErrorCode SNESGetMaxNonlinearStepFailures(SNES snes, PetscInt *maxFails) 119550ffb88aSMatthew Knepley { 119650ffb88aSMatthew Knepley PetscFunctionBegin; 11970700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 11984482741eSBarry Smith PetscValidIntPointer(maxFails,2); 119950ffb88aSMatthew Knepley *maxFails = snes->maxFailures; 12003a40ed3dSBarry Smith PetscFunctionReturn(0); 12019b94acceSBarry Smith } 1202a847f771SSatish Balay 12034a2ae208SSatish Balay #undef __FUNCT__ 12042541af92SBarry Smith #define __FUNCT__ "SNESGetNumberFunctionEvals" 12052541af92SBarry Smith /*@ 12062541af92SBarry Smith SNESGetNumberFunctionEvals - Gets the number of user provided function evaluations 12072541af92SBarry Smith done by SNES. 12082541af92SBarry Smith 12092541af92SBarry Smith Not Collective 12102541af92SBarry Smith 12112541af92SBarry Smith Input Parameter: 12122541af92SBarry Smith . snes - SNES context 12132541af92SBarry Smith 12142541af92SBarry Smith Output Parameter: 12152541af92SBarry Smith . nfuncs - number of evaluations 12162541af92SBarry Smith 12172541af92SBarry Smith Level: intermediate 12182541af92SBarry Smith 1219971e163fSPeter Brune Notes: Reset every time SNESSolve is called unless SNESSetCountersReset() is used. 1220971e163fSPeter Brune 12212541af92SBarry Smith .keywords: SNES, nonlinear, get, maximum, unsuccessful, steps 122258ebbce7SBarry Smith 1223971e163fSPeter Brune .seealso: SNESGetMaxLinearSolveFailures(), SNESGetLinearSolveIterations(), SNESSetMaxLinearSolveFailures(), SNESGetLinearSolveFailures(), SNESSetCountersReset() 12242541af92SBarry Smith @*/ 12257087cfbeSBarry Smith PetscErrorCode SNESGetNumberFunctionEvals(SNES snes, PetscInt *nfuncs) 12262541af92SBarry Smith { 12272541af92SBarry Smith PetscFunctionBegin; 12280700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 12292541af92SBarry Smith PetscValidIntPointer(nfuncs,2); 12302541af92SBarry Smith *nfuncs = snes->nfuncs; 12312541af92SBarry Smith PetscFunctionReturn(0); 12322541af92SBarry Smith } 12332541af92SBarry Smith 12342541af92SBarry Smith #undef __FUNCT__ 12353d4c4710SBarry Smith #define __FUNCT__ "SNESGetLinearSolveFailures" 12363d4c4710SBarry Smith /*@ 12373d4c4710SBarry Smith SNESGetLinearSolveFailures - Gets the number of failed (non-converged) 12383d4c4710SBarry Smith linear solvers. 12393d4c4710SBarry Smith 12403d4c4710SBarry Smith Not Collective 12413d4c4710SBarry Smith 12423d4c4710SBarry Smith Input Parameter: 12433d4c4710SBarry Smith . snes - SNES context 12443d4c4710SBarry Smith 12453d4c4710SBarry Smith Output Parameter: 12463d4c4710SBarry Smith . nfails - number of failed solves 12473d4c4710SBarry Smith 12483d4c4710SBarry Smith Notes: 12493d4c4710SBarry Smith This counter is reset to zero for each successive call to SNESSolve(). 12503d4c4710SBarry Smith 12513d4c4710SBarry Smith Level: intermediate 12523d4c4710SBarry Smith 12533d4c4710SBarry Smith .keywords: SNES, nonlinear, get, number, unsuccessful, steps 125458ebbce7SBarry Smith 1255e1c61ce8SBarry Smith .seealso: SNESGetMaxLinearSolveFailures(), SNESGetLinearSolveIterations(), SNESSetMaxLinearSolveFailures() 12563d4c4710SBarry Smith @*/ 12577087cfbeSBarry Smith PetscErrorCode SNESGetLinearSolveFailures(SNES snes,PetscInt *nfails) 12583d4c4710SBarry Smith { 12593d4c4710SBarry Smith PetscFunctionBegin; 12600700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 12613d4c4710SBarry Smith PetscValidIntPointer(nfails,2); 12623d4c4710SBarry Smith *nfails = snes->numLinearSolveFailures; 12633d4c4710SBarry Smith PetscFunctionReturn(0); 12643d4c4710SBarry Smith } 12653d4c4710SBarry Smith 12663d4c4710SBarry Smith #undef __FUNCT__ 12673d4c4710SBarry Smith #define __FUNCT__ "SNESSetMaxLinearSolveFailures" 12683d4c4710SBarry Smith /*@ 12693d4c4710SBarry Smith SNESSetMaxLinearSolveFailures - the number of failed linear solve attempts 12703d4c4710SBarry Smith allowed before SNES returns with a diverged reason of SNES_DIVERGED_LINEAR_SOLVE 12713d4c4710SBarry Smith 12723f9fe445SBarry Smith Logically Collective on SNES 12733d4c4710SBarry Smith 12743d4c4710SBarry Smith Input Parameters: 12753d4c4710SBarry Smith + snes - SNES context 12763d4c4710SBarry Smith - maxFails - maximum allowed linear solve failures 12773d4c4710SBarry Smith 12783d4c4710SBarry Smith Level: intermediate 12793d4c4710SBarry Smith 1280a6796414SBarry Smith Notes: By default this is 0; that is SNES returns on the first failed linear solve 12813d4c4710SBarry Smith 12823d4c4710SBarry Smith .keywords: SNES, nonlinear, set, maximum, unsuccessful, steps 12833d4c4710SBarry Smith 128458ebbce7SBarry Smith .seealso: SNESGetLinearSolveFailures(), SNESGetMaxLinearSolveFailures(), SNESGetLinearSolveIterations() 12853d4c4710SBarry Smith @*/ 12867087cfbeSBarry Smith PetscErrorCode SNESSetMaxLinearSolveFailures(SNES snes, PetscInt maxFails) 12873d4c4710SBarry Smith { 12883d4c4710SBarry Smith PetscFunctionBegin; 12890700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 1290c5eb9154SBarry Smith PetscValidLogicalCollectiveInt(snes,maxFails,2); 12913d4c4710SBarry Smith snes->maxLinearSolveFailures = maxFails; 12923d4c4710SBarry Smith PetscFunctionReturn(0); 12933d4c4710SBarry Smith } 12943d4c4710SBarry Smith 12953d4c4710SBarry Smith #undef __FUNCT__ 12963d4c4710SBarry Smith #define __FUNCT__ "SNESGetMaxLinearSolveFailures" 12973d4c4710SBarry Smith /*@ 12983d4c4710SBarry Smith SNESGetMaxLinearSolveFailures - gets the maximum number of linear solve failures that 12993d4c4710SBarry Smith are allowed before SNES terminates 13003d4c4710SBarry Smith 13013d4c4710SBarry Smith Not Collective 13023d4c4710SBarry Smith 13033d4c4710SBarry Smith Input Parameter: 13043d4c4710SBarry Smith . snes - SNES context 13053d4c4710SBarry Smith 13063d4c4710SBarry Smith Output Parameter: 13073d4c4710SBarry Smith . maxFails - maximum of unsuccessful solves allowed 13083d4c4710SBarry Smith 13093d4c4710SBarry Smith Level: intermediate 13103d4c4710SBarry Smith 13113d4c4710SBarry Smith Notes: By default this is 1; that is SNES returns on the first failed linear solve 13123d4c4710SBarry Smith 13133d4c4710SBarry Smith .keywords: SNES, nonlinear, get, maximum, unsuccessful, steps 13143d4c4710SBarry Smith 1315e1c61ce8SBarry Smith .seealso: SNESGetLinearSolveFailures(), SNESGetLinearSolveIterations(), SNESSetMaxLinearSolveFailures(), 13163d4c4710SBarry Smith @*/ 13177087cfbeSBarry Smith PetscErrorCode SNESGetMaxLinearSolveFailures(SNES snes, PetscInt *maxFails) 13183d4c4710SBarry Smith { 13193d4c4710SBarry Smith PetscFunctionBegin; 13200700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 13213d4c4710SBarry Smith PetscValidIntPointer(maxFails,2); 13223d4c4710SBarry Smith *maxFails = snes->maxLinearSolveFailures; 13233d4c4710SBarry Smith PetscFunctionReturn(0); 13243d4c4710SBarry Smith } 13253d4c4710SBarry Smith 13263d4c4710SBarry Smith #undef __FUNCT__ 1327b850b91aSLisandro Dalcin #define __FUNCT__ "SNESGetLinearSolveIterations" 1328c96a6f78SLois Curfman McInnes /*@ 1329b850b91aSLisandro Dalcin SNESGetLinearSolveIterations - Gets the total number of linear iterations 1330c96a6f78SLois Curfman McInnes used by the nonlinear solver. 1331c96a6f78SLois Curfman McInnes 1332c7afd0dbSLois Curfman McInnes Not Collective 1333c7afd0dbSLois Curfman McInnes 1334c96a6f78SLois Curfman McInnes Input Parameter: 1335c96a6f78SLois Curfman McInnes . snes - SNES context 1336c96a6f78SLois Curfman McInnes 1337c96a6f78SLois Curfman McInnes Output Parameter: 1338c96a6f78SLois Curfman McInnes . lits - number of linear iterations 1339c96a6f78SLois Curfman McInnes 1340c96a6f78SLois Curfman McInnes Notes: 1341971e163fSPeter Brune This counter is reset to zero for each successive call to SNESSolve() unless SNESSetCountersReset() is used. 1342c96a6f78SLois Curfman McInnes 134336851e7fSLois Curfman McInnes Level: intermediate 134436851e7fSLois Curfman McInnes 1345c96a6f78SLois Curfman McInnes .keywords: SNES, nonlinear, get, number, linear, iterations 13462b668275SBarry Smith 1347971e163fSPeter Brune .seealso: SNESGetIterationNumber(), SNESGetFunctionNorm(), SNESGetLinearSolveFailures(), SNESGetMaxLinearSolveFailures(), SNESSetCountersReset() 1348c96a6f78SLois Curfman McInnes @*/ 13497087cfbeSBarry Smith PetscErrorCode SNESGetLinearSolveIterations(SNES snes,PetscInt *lits) 1350c96a6f78SLois Curfman McInnes { 13513a40ed3dSBarry Smith PetscFunctionBegin; 13520700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 13534482741eSBarry Smith PetscValidIntPointer(lits,2); 1354c96a6f78SLois Curfman McInnes *lits = snes->linear_its; 13553a40ed3dSBarry Smith PetscFunctionReturn(0); 1356c96a6f78SLois Curfman McInnes } 1357c96a6f78SLois Curfman McInnes 1358971e163fSPeter Brune #undef __FUNCT__ 1359971e163fSPeter Brune #define __FUNCT__ "SNESSetCountersReset" 1360971e163fSPeter Brune /*@ 1361971e163fSPeter Brune SNESSetCountersReset - Sets whether or not the counters for linear iterations and function evaluations 1362971e163fSPeter Brune are reset every time SNESSolve() is called. 1363971e163fSPeter Brune 1364971e163fSPeter Brune Logically Collective on SNES 1365971e163fSPeter Brune 1366971e163fSPeter Brune Input Parameter: 1367971e163fSPeter Brune + snes - SNES context 1368971e163fSPeter Brune - reset - whether to reset the counters or not 1369971e163fSPeter Brune 1370971e163fSPeter Brune Notes: 1371971e163fSPeter Brune This is automatically called with FALSE 1372971e163fSPeter Brune 1373971e163fSPeter Brune Level: developer 1374971e163fSPeter Brune 1375971e163fSPeter Brune .keywords: SNES, nonlinear, set, reset, number, linear, iterations 1376971e163fSPeter Brune 1377971e163fSPeter Brune .seealso: SNESGetNumberFunctionEvals(), SNESGetNumberLinearSolveIterations(), SNESGetPC() 1378971e163fSPeter Brune @*/ 1379971e163fSPeter Brune PetscErrorCode SNESSetCountersReset(SNES snes,PetscBool reset) 1380971e163fSPeter Brune { 1381971e163fSPeter Brune PetscFunctionBegin; 1382971e163fSPeter Brune PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 1383971e163fSPeter Brune PetscValidLogicalCollectiveBool(snes,reset,2); 1384971e163fSPeter Brune snes->counters_reset = reset; 1385971e163fSPeter Brune PetscFunctionReturn(0); 1386971e163fSPeter Brune } 1387971e163fSPeter Brune 138882bf6240SBarry Smith 13894a2ae208SSatish Balay #undef __FUNCT__ 13902999313aSBarry Smith #define __FUNCT__ "SNESSetKSP" 13912999313aSBarry Smith /*@ 13922999313aSBarry Smith SNESSetKSP - Sets a KSP context for the SNES object to use 13932999313aSBarry Smith 13942999313aSBarry Smith Not Collective, but the SNES and KSP objects must live on the same MPI_Comm 13952999313aSBarry Smith 13962999313aSBarry Smith Input Parameters: 13972999313aSBarry Smith + snes - the SNES context 13982999313aSBarry Smith - ksp - the KSP context 13992999313aSBarry Smith 14002999313aSBarry Smith Notes: 14012999313aSBarry Smith The SNES object already has its KSP object, you can obtain with SNESGetKSP() 14022999313aSBarry Smith so this routine is rarely needed. 14032999313aSBarry Smith 14042999313aSBarry Smith The KSP object that is already in the SNES object has its reference count 14052999313aSBarry Smith decreased by one. 14062999313aSBarry Smith 14072999313aSBarry Smith Level: developer 14082999313aSBarry Smith 14092999313aSBarry Smith .keywords: SNES, nonlinear, get, KSP, context 14102999313aSBarry Smith 14112999313aSBarry Smith .seealso: KSPGetPC(), SNESCreate(), KSPCreate(), SNESSetKSP() 14122999313aSBarry Smith @*/ 14137087cfbeSBarry Smith PetscErrorCode SNESSetKSP(SNES snes,KSP ksp) 14142999313aSBarry Smith { 14152999313aSBarry Smith PetscErrorCode ierr; 14162999313aSBarry Smith 14172999313aSBarry Smith PetscFunctionBegin; 14180700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 14190700a824SBarry Smith PetscValidHeaderSpecific(ksp,KSP_CLASSID,2); 14202999313aSBarry Smith PetscCheckSameComm(snes,1,ksp,2); 14217dcf0eaaSdalcinl ierr = PetscObjectReference((PetscObject)ksp);CHKERRQ(ierr); 1422906ed7ccSBarry Smith if (snes->ksp) {ierr = PetscObjectDereference((PetscObject)snes->ksp);CHKERRQ(ierr);} 14232999313aSBarry Smith snes->ksp = ksp; 14242999313aSBarry Smith PetscFunctionReturn(0); 14252999313aSBarry Smith } 14262999313aSBarry Smith 14279b94acceSBarry Smith /* -----------------------------------------------------------*/ 14284a2ae208SSatish Balay #undef __FUNCT__ 14294a2ae208SSatish Balay #define __FUNCT__ "SNESCreate" 143052baeb72SSatish Balay /*@ 14319b94acceSBarry Smith SNESCreate - Creates a nonlinear solver context. 14329b94acceSBarry Smith 1433c7afd0dbSLois Curfman McInnes Collective on MPI_Comm 1434c7afd0dbSLois Curfman McInnes 1435c7afd0dbSLois Curfman McInnes Input Parameters: 1436906ed7ccSBarry Smith . comm - MPI communicator 14379b94acceSBarry Smith 14389b94acceSBarry Smith Output Parameter: 14399b94acceSBarry Smith . outsnes - the new SNES context 14409b94acceSBarry Smith 1441c7afd0dbSLois Curfman McInnes Options Database Keys: 1442c7afd0dbSLois Curfman McInnes + -snes_mf - Activates default matrix-free Jacobian-vector products, 1443c7afd0dbSLois Curfman McInnes and no preconditioning matrix 1444c7afd0dbSLois Curfman McInnes . -snes_mf_operator - Activates default matrix-free Jacobian-vector 1445c7afd0dbSLois Curfman McInnes products, and a user-provided preconditioning matrix 1446c7afd0dbSLois Curfman McInnes as set by SNESSetJacobian() 1447c7afd0dbSLois Curfman McInnes - -snes_fd - Uses (slow!) finite differences to compute Jacobian 1448c1f60f51SBarry Smith 144936851e7fSLois Curfman McInnes Level: beginner 145036851e7fSLois Curfman McInnes 14519b94acceSBarry Smith .keywords: SNES, nonlinear, create, context 14529b94acceSBarry Smith 1453a8054027SBarry Smith .seealso: SNESSolve(), SNESDestroy(), SNES, SNESSetLagPreconditioner() 1454a8054027SBarry Smith 14559b94acceSBarry Smith @*/ 14567087cfbeSBarry Smith PetscErrorCode SNESCreate(MPI_Comm comm,SNES *outsnes) 14579b94acceSBarry Smith { 1458dfbe8321SBarry Smith PetscErrorCode ierr; 14599b94acceSBarry Smith SNES snes; 1460fa9f3622SBarry Smith SNESKSPEW *kctx; 146137fcc0dbSBarry Smith 14623a40ed3dSBarry Smith PetscFunctionBegin; 1463ed1caa07SMatthew Knepley PetscValidPointer(outsnes,2); 14640298fd71SBarry Smith *outsnes = NULL; 1465519f805aSKarl Rupp #if !defined(PETSC_USE_DYNAMIC_LIBRARIES) 1466607a6623SBarry Smith ierr = SNESInitializePackage();CHKERRQ(ierr); 14678ba1e511SMatthew Knepley #endif 14688ba1e511SMatthew Knepley 146967c2884eSBarry Smith ierr = PetscHeaderCreate(snes,_p_SNES,struct _SNESOps,SNES_CLASSID,"SNES","Nonlinear solver","SNES",comm,SNESDestroy,SNESView);CHKERRQ(ierr); 14707adad957SLisandro Dalcin 14718d359177SBarry Smith snes->ops->converged = SNESConvergedDefault; 14722c155ee1SBarry Smith snes->usesksp = PETSC_TRUE; 147388976e71SPeter Brune snes->tolerancesset = PETSC_FALSE; 14749b94acceSBarry Smith snes->max_its = 50; 14759750a799SBarry Smith snes->max_funcs = 10000; 14769b94acceSBarry Smith snes->norm = 0.0; 1477365a6726SPeter Brune snes->normschedule = SNES_NORM_ALWAYS; 14786c67d002SPeter Brune snes->functype = SNES_FUNCTION_DEFAULT; 1479b4874afaSBarry Smith snes->rtol = 1.e-8; 1480b4874afaSBarry Smith snes->ttol = 0.0; 148170441072SBarry Smith snes->abstol = 1.e-50; 1482c60f73f4SPeter Brune snes->stol = 1.e-8; 14834b27c08aSLois Curfman McInnes snes->deltatol = 1.e-12; 14849b94acceSBarry Smith snes->nfuncs = 0; 148550ffb88aSMatthew Knepley snes->numFailures = 0; 148650ffb88aSMatthew Knepley snes->maxFailures = 1; 14877a00f4a9SLois Curfman McInnes snes->linear_its = 0; 1488e35cf81dSBarry Smith snes->lagjacobian = 1; 148937ec4e1aSPeter Brune snes->jac_iter = 0; 149037ec4e1aSPeter Brune snes->lagjac_persist = PETSC_FALSE; 1491a8054027SBarry Smith snes->lagpreconditioner = 1; 149237ec4e1aSPeter Brune snes->pre_iter = 0; 149337ec4e1aSPeter Brune snes->lagpre_persist = PETSC_FALSE; 1494639f9d9dSBarry Smith snes->numbermonitors = 0; 14959b94acceSBarry Smith snes->data = 0; 14964dc4c822SBarry Smith snes->setupcalled = PETSC_FALSE; 1497186905e3SBarry Smith snes->ksp_ewconv = PETSC_FALSE; 14986f24a144SLois Curfman McInnes snes->nwork = 0; 149958c9b817SLisandro Dalcin snes->work = 0; 150058c9b817SLisandro Dalcin snes->nvwork = 0; 150158c9b817SLisandro Dalcin snes->vwork = 0; 1502758f92a0SBarry Smith snes->conv_hist_len = 0; 1503758f92a0SBarry Smith snes->conv_hist_max = 0; 15040298fd71SBarry Smith snes->conv_hist = NULL; 15050298fd71SBarry Smith snes->conv_hist_its = NULL; 1506758f92a0SBarry Smith snes->conv_hist_reset = PETSC_TRUE; 1507971e163fSPeter Brune snes->counters_reset = PETSC_TRUE; 1508e4ed7901SPeter Brune snes->vec_func_init_set = PETSC_FALSE; 1509184914b5SBarry Smith snes->reason = SNES_CONVERGED_ITERATING; 1510c40d0f55SPeter Brune snes->pcside = PC_RIGHT; 1511c40d0f55SPeter Brune 1512d8f46077SPeter Brune snes->mf = PETSC_FALSE; 1513d8f46077SPeter Brune snes->mf_operator = PETSC_FALSE; 1514d8f46077SPeter Brune snes->mf_version = 1; 1515d8f46077SPeter Brune 15163d4c4710SBarry Smith snes->numLinearSolveFailures = 0; 15173d4c4710SBarry Smith snes->maxLinearSolveFailures = 1; 15183d4c4710SBarry Smith 15199b94acceSBarry Smith /* Create context to compute Eisenstat-Walker relative tolerance for KSP */ 152038f2d2fdSLisandro Dalcin ierr = PetscNewLog(snes,SNESKSPEW,&kctx);CHKERRQ(ierr); 1521f5af7f23SKarl Rupp 15229b94acceSBarry Smith snes->kspconvctx = (void*)kctx; 15239b94acceSBarry Smith kctx->version = 2; 15249b94acceSBarry Smith kctx->rtol_0 = .3; /* Eisenstat and Walker suggest rtol_0=.5, but 15259b94acceSBarry Smith this was too large for some test cases */ 152675567043SBarry Smith kctx->rtol_last = 0.0; 15279b94acceSBarry Smith kctx->rtol_max = .9; 15289b94acceSBarry Smith kctx->gamma = 1.0; 152962d1f40fSBarry Smith kctx->alpha = .5*(1.0 + PetscSqrtReal(5.0)); 153071f87433Sdalcinl kctx->alpha2 = kctx->alpha; 15319b94acceSBarry Smith kctx->threshold = .1; 153275567043SBarry Smith kctx->lresid_last = 0.0; 153375567043SBarry Smith kctx->norm_last = 0.0; 15349b94acceSBarry Smith 15359b94acceSBarry Smith *outsnes = snes; 15363a40ed3dSBarry Smith PetscFunctionReturn(0); 15379b94acceSBarry Smith } 15389b94acceSBarry Smith 153988f0584fSBarry Smith /*MC 154018e2ec27SBarry Smith SNESFunction - functional form used to convey the nonlinear function to be solved by SNES 154188f0584fSBarry Smith 154288f0584fSBarry Smith Synopsis: 1543f2ba6396SBarry Smith #include "petscsnes.h" 154488f0584fSBarry Smith SNESFunction(SNES snes,Vec x,Vec f,void *ctx); 154588f0584fSBarry Smith 154688f0584fSBarry Smith Input Parameters: 154788f0584fSBarry Smith + snes - the SNES context 154888f0584fSBarry Smith . x - state at which to evaluate residual 154988f0584fSBarry Smith - ctx - optional user-defined function context, passed in with SNESSetFunction() 155088f0584fSBarry Smith 155188f0584fSBarry Smith Output Parameter: 155288f0584fSBarry Smith . f - vector to put residual (function value) 155388f0584fSBarry Smith 1554878cb397SSatish Balay Level: intermediate 1555878cb397SSatish Balay 155688f0584fSBarry Smith .seealso: SNESSetFunction(), SNESGetFunction() 155788f0584fSBarry Smith M*/ 155888f0584fSBarry Smith 15594a2ae208SSatish Balay #undef __FUNCT__ 15604a2ae208SSatish Balay #define __FUNCT__ "SNESSetFunction" 15619b94acceSBarry Smith /*@C 15629b94acceSBarry Smith SNESSetFunction - Sets the function evaluation routine and function 15639b94acceSBarry Smith vector for use by the SNES routines in solving systems of nonlinear 15649b94acceSBarry Smith equations. 15659b94acceSBarry Smith 15663f9fe445SBarry Smith Logically Collective on SNES 1567fee21e36SBarry Smith 1568c7afd0dbSLois Curfman McInnes Input Parameters: 1569c7afd0dbSLois Curfman McInnes + snes - the SNES context 1570c7afd0dbSLois Curfman McInnes . r - vector to store function value 157188f0584fSBarry Smith . SNESFunction - function evaluation routine 1572c7afd0dbSLois Curfman McInnes - ctx - [optional] user-defined context for private data for the 15730298fd71SBarry Smith function evaluation routine (may be NULL) 15749b94acceSBarry Smith 15759b94acceSBarry Smith Notes: 15769b94acceSBarry Smith The Newton-like methods typically solve linear systems of the form 15779b94acceSBarry Smith $ f'(x) x = -f(x), 1578c7afd0dbSLois Curfman McInnes where f'(x) denotes the Jacobian matrix and f(x) is the function. 15799b94acceSBarry Smith 158036851e7fSLois Curfman McInnes Level: beginner 158136851e7fSLois Curfman McInnes 15829b94acceSBarry Smith .keywords: SNES, nonlinear, set, function 15839b94acceSBarry Smith 1584bf388a1fSBarry Smith .seealso: SNESGetFunction(), SNESComputeFunction(), SNESSetJacobian(), SNESSetPicard(), SNESFunction 15859b94acceSBarry Smith @*/ 158688f0584fSBarry Smith PetscErrorCode SNESSetFunction(SNES snes,Vec r,PetscErrorCode (*SNESFunction)(SNES,Vec,Vec,void*),void *ctx) 15879b94acceSBarry Smith { 158885385478SLisandro Dalcin PetscErrorCode ierr; 15896cab3a1bSJed Brown DM dm; 15906cab3a1bSJed Brown 15913a40ed3dSBarry Smith PetscFunctionBegin; 15920700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 1593d2a683ecSLisandro Dalcin if (r) { 1594d2a683ecSLisandro Dalcin PetscValidHeaderSpecific(r,VEC_CLASSID,2); 1595d2a683ecSLisandro Dalcin PetscCheckSameComm(snes,1,r,2); 159685385478SLisandro Dalcin ierr = PetscObjectReference((PetscObject)r);CHKERRQ(ierr); 15976bf464f9SBarry Smith ierr = VecDestroy(&snes->vec_func);CHKERRQ(ierr); 1598f5af7f23SKarl Rupp 159985385478SLisandro Dalcin snes->vec_func = r; 1600d2a683ecSLisandro Dalcin } 16016cab3a1bSJed Brown ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr); 160288f0584fSBarry Smith ierr = DMSNESSetFunction(dm,SNESFunction,ctx);CHKERRQ(ierr); 16033a40ed3dSBarry Smith PetscFunctionReturn(0); 16049b94acceSBarry Smith } 16059b94acceSBarry Smith 1606646217ecSPeter Brune 1607646217ecSPeter Brune #undef __FUNCT__ 1608e4ed7901SPeter Brune #define __FUNCT__ "SNESSetInitialFunction" 1609e4ed7901SPeter Brune /*@C 1610e4ed7901SPeter Brune SNESSetInitialFunction - Sets the function vector to be used as the 1611e4ed7901SPeter Brune function norm at the initialization of the method. In some 1612e4ed7901SPeter Brune instances, the user has precomputed the function before calling 1613e4ed7901SPeter Brune SNESSolve. This function allows one to avoid a redundant call 1614e4ed7901SPeter Brune to SNESComputeFunction in that case. 1615e4ed7901SPeter Brune 1616e4ed7901SPeter Brune Logically Collective on SNES 1617e4ed7901SPeter Brune 1618e4ed7901SPeter Brune Input Parameters: 1619e4ed7901SPeter Brune + snes - the SNES context 1620e4ed7901SPeter Brune - f - vector to store function value 1621e4ed7901SPeter Brune 1622e4ed7901SPeter Brune Notes: 1623e4ed7901SPeter Brune This should not be modified during the solution procedure. 1624e4ed7901SPeter Brune 1625e4ed7901SPeter Brune This is used extensively in the SNESFAS hierarchy and in nonlinear preconditioning. 1626e4ed7901SPeter Brune 1627e4ed7901SPeter Brune Level: developer 1628e4ed7901SPeter Brune 1629e4ed7901SPeter Brune .keywords: SNES, nonlinear, set, function 1630e4ed7901SPeter Brune 1631e4ed7901SPeter Brune .seealso: SNESSetFunction(), SNESComputeFunction(), SNESSetInitialFunctionNorm() 1632e4ed7901SPeter Brune @*/ 1633e4ed7901SPeter Brune PetscErrorCode SNESSetInitialFunction(SNES snes, Vec f) 1634e4ed7901SPeter Brune { 1635e4ed7901SPeter Brune PetscErrorCode ierr; 1636e4ed7901SPeter Brune Vec vec_func; 1637e4ed7901SPeter Brune 1638e4ed7901SPeter Brune PetscFunctionBegin; 1639e4ed7901SPeter Brune PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 1640e4ed7901SPeter Brune PetscValidHeaderSpecific(f,VEC_CLASSID,2); 1641e4ed7901SPeter Brune PetscCheckSameComm(snes,1,f,2); 16425c9e203fSPeter Brune if (snes->pcside == PC_LEFT && snes->functype == SNES_FUNCTION_PRECONDITIONED) { 1643902f982fSPeter Brune snes->vec_func_init_set = PETSC_FALSE; 1644902f982fSPeter Brune PetscFunctionReturn(0); 1645902f982fSPeter Brune } 16460298fd71SBarry Smith ierr = SNESGetFunction(snes,&vec_func,NULL,NULL);CHKERRQ(ierr); 1647e4ed7901SPeter Brune ierr = VecCopy(f, vec_func);CHKERRQ(ierr); 1648f5af7f23SKarl Rupp 1649217b9c2eSPeter Brune snes->vec_func_init_set = PETSC_TRUE; 1650e4ed7901SPeter Brune PetscFunctionReturn(0); 1651e4ed7901SPeter Brune } 1652e4ed7901SPeter Brune 1653e4ed7901SPeter Brune #undef __FUNCT__ 1654365a6726SPeter Brune #define __FUNCT__ "SNESSetNormSchedule" 1655534ebe21SPeter Brune /*@ 1656365a6726SPeter Brune SNESSetNormSchedule - Sets the SNESNormSchedule used in covergence and monitoring 1657534ebe21SPeter Brune of the SNES method. 1658534ebe21SPeter Brune 1659534ebe21SPeter Brune Logically Collective on SNES 1660534ebe21SPeter Brune 1661534ebe21SPeter Brune Input Parameters: 1662534ebe21SPeter Brune + snes - the SNES context 1663365a6726SPeter Brune - normschedule - the frequency of norm computation 1664534ebe21SPeter Brune 1665534ebe21SPeter Brune Notes: 1666365a6726SPeter Brune Only certain SNES methods support certain SNESNormSchedules. Most require evaluation 1667534ebe21SPeter Brune of the nonlinear function and the taking of its norm at every iteration to 1668534ebe21SPeter Brune even ensure convergence at all. However, methods such as custom Gauss-Seidel methods 1669534ebe21SPeter Brune (SNESGS) and the like do not require the norm of the function to be computed, and therfore 1670534ebe21SPeter Brune may either be monitored for convergence or not. As these are often used as nonlinear 1671534ebe21SPeter Brune preconditioners, monitoring the norm of their error is not a useful enterprise within 1672534ebe21SPeter Brune their solution. 1673534ebe21SPeter Brune 1674534ebe21SPeter Brune Level: developer 1675534ebe21SPeter Brune 1676534ebe21SPeter Brune .keywords: SNES, nonlinear, set, function, norm, type 1677534ebe21SPeter Brune 1678365a6726SPeter Brune .seealso: SNESGetNormSchedule(), SNESComputeFunction(), VecNorm(), SNESSetFunction(), SNESSetInitialFunction(), SNESNormSchedule 1679534ebe21SPeter Brune @*/ 1680365a6726SPeter Brune PetscErrorCode SNESSetNormSchedule(SNES snes, SNESNormSchedule normschedule) 1681534ebe21SPeter Brune { 1682534ebe21SPeter Brune PetscFunctionBegin; 1683534ebe21SPeter Brune PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 1684365a6726SPeter Brune snes->normschedule = normschedule; 1685534ebe21SPeter Brune PetscFunctionReturn(0); 1686534ebe21SPeter Brune } 1687534ebe21SPeter Brune 1688534ebe21SPeter Brune 1689534ebe21SPeter Brune #undef __FUNCT__ 1690365a6726SPeter Brune #define __FUNCT__ "SNESGetNormSchedule" 1691534ebe21SPeter Brune /*@ 1692365a6726SPeter Brune SNESGetNormSchedule - Gets the SNESNormSchedule used in covergence and monitoring 1693534ebe21SPeter Brune of the SNES method. 1694534ebe21SPeter Brune 1695534ebe21SPeter Brune Logically Collective on SNES 1696534ebe21SPeter Brune 1697534ebe21SPeter Brune Input Parameters: 1698534ebe21SPeter Brune + snes - the SNES context 1699365a6726SPeter Brune - normschedule - the type of the norm used 1700534ebe21SPeter Brune 1701534ebe21SPeter Brune Level: advanced 1702534ebe21SPeter Brune 1703534ebe21SPeter Brune .keywords: SNES, nonlinear, set, function, norm, type 1704534ebe21SPeter Brune 1705365a6726SPeter Brune .seealso: SNESSetNormSchedule(), SNESComputeFunction(), VecNorm(), SNESSetFunction(), SNESSetInitialFunction(), SNESNormSchedule 1706534ebe21SPeter Brune @*/ 1707365a6726SPeter Brune PetscErrorCode SNESGetNormSchedule(SNES snes, SNESNormSchedule *normschedule) 1708534ebe21SPeter Brune { 1709534ebe21SPeter Brune PetscFunctionBegin; 1710534ebe21SPeter Brune PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 1711365a6726SPeter Brune *normschedule = snes->normschedule; 1712534ebe21SPeter Brune PetscFunctionReturn(0); 1713534ebe21SPeter Brune } 1714534ebe21SPeter Brune 171547073ea2SPeter Brune 171647073ea2SPeter Brune #undef __FUNCT__ 171747073ea2SPeter Brune #define __FUNCT__ "SNESSetFunctionType" 171847073ea2SPeter Brune /*@C 171947073ea2SPeter Brune SNESSetFunctionType - Sets the SNESNormSchedule used in covergence and monitoring 172047073ea2SPeter Brune of the SNES method. 172147073ea2SPeter Brune 172247073ea2SPeter Brune Logically Collective on SNES 172347073ea2SPeter Brune 172447073ea2SPeter Brune Input Parameters: 172547073ea2SPeter Brune + snes - the SNES context 172647073ea2SPeter Brune - normschedule - the frequency of norm computation 172747073ea2SPeter Brune 172847073ea2SPeter Brune Notes: 172947073ea2SPeter Brune Only certain SNES methods support certain SNESNormSchedules. Most require evaluation 173047073ea2SPeter Brune of the nonlinear function and the taking of its norm at every iteration to 173147073ea2SPeter Brune even ensure convergence at all. However, methods such as custom Gauss-Seidel methods 173247073ea2SPeter Brune (SNESGS) and the like do not require the norm of the function to be computed, and therfore 173347073ea2SPeter Brune may either be monitored for convergence or not. As these are often used as nonlinear 173447073ea2SPeter Brune preconditioners, monitoring the norm of their error is not a useful enterprise within 173547073ea2SPeter Brune their solution. 173647073ea2SPeter Brune 173747073ea2SPeter Brune Level: developer 173847073ea2SPeter Brune 173947073ea2SPeter Brune .keywords: SNES, nonlinear, set, function, norm, type 174047073ea2SPeter Brune 174147073ea2SPeter Brune .seealso: SNESGetNormSchedule(), SNESComputeFunction(), VecNorm(), SNESSetFunction(), SNESSetInitialFunction(), SNESNormSchedule 174247073ea2SPeter Brune @*/ 174347073ea2SPeter Brune PetscErrorCode SNESSetFunctionType(SNES snes, SNESFunctionType type) 174447073ea2SPeter Brune { 174547073ea2SPeter Brune PetscFunctionBegin; 174647073ea2SPeter Brune PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 174747073ea2SPeter Brune snes->functype = type; 174847073ea2SPeter Brune PetscFunctionReturn(0); 174947073ea2SPeter Brune } 175047073ea2SPeter Brune 175147073ea2SPeter Brune 175247073ea2SPeter Brune #undef __FUNCT__ 175347073ea2SPeter Brune #define __FUNCT__ "SNESGetFunctionType" 175447073ea2SPeter Brune /*@C 175547073ea2SPeter Brune SNESGetFunctionType - Gets the SNESNormSchedule used in covergence and monitoring 175647073ea2SPeter Brune of the SNES method. 175747073ea2SPeter Brune 175847073ea2SPeter Brune Logically Collective on SNES 175947073ea2SPeter Brune 176047073ea2SPeter Brune Input Parameters: 176147073ea2SPeter Brune + snes - the SNES context 176247073ea2SPeter Brune - normschedule - the type of the norm used 176347073ea2SPeter Brune 176447073ea2SPeter Brune Level: advanced 176547073ea2SPeter Brune 176647073ea2SPeter Brune .keywords: SNES, nonlinear, set, function, norm, type 176747073ea2SPeter Brune 176847073ea2SPeter Brune .seealso: SNESSetNormSchedule(), SNESComputeFunction(), VecNorm(), SNESSetFunction(), SNESSetInitialFunction(), SNESNormSchedule 176947073ea2SPeter Brune @*/ 177047073ea2SPeter Brune PetscErrorCode SNESGetFunctionType(SNES snes, SNESFunctionType *type) 177147073ea2SPeter Brune { 177247073ea2SPeter Brune PetscFunctionBegin; 177347073ea2SPeter Brune PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 177447073ea2SPeter Brune *type = snes->functype; 1775534ebe21SPeter Brune PetscFunctionReturn(0); 1776534ebe21SPeter Brune } 1777534ebe21SPeter Brune 1778bf388a1fSBarry Smith /*MC 1779bf388a1fSBarry Smith SNESGSFunction - function used to convey a Gauss-Seidel sweep on the nonlinear function 1780bf388a1fSBarry Smith 1781bf388a1fSBarry Smith Synopsis: 1782bf388a1fSBarry Smith #include "petscsnes.h" 1783bf388a1fSBarry Smith $ SNESGSFunction(SNES snes,Vec x,Vec b,void *ctx); 1784bf388a1fSBarry Smith 1785bf388a1fSBarry Smith + X - solution vector 1786bf388a1fSBarry Smith . B - RHS vector 1787bf388a1fSBarry Smith - ctx - optional user-defined Gauss-Seidel context 1788bf388a1fSBarry Smith 1789878cb397SSatish Balay Level: intermediate 1790878cb397SSatish Balay 1791bf388a1fSBarry Smith .seealso: SNESSetGS(), SNESGetGS() 1792bf388a1fSBarry Smith M*/ 1793bf388a1fSBarry Smith 1794534ebe21SPeter Brune #undef __FUNCT__ 1795646217ecSPeter Brune #define __FUNCT__ "SNESSetGS" 1796c79ef259SPeter Brune /*@C 1797c79ef259SPeter Brune SNESSetGS - Sets the user nonlinear Gauss-Seidel routine for 1798c79ef259SPeter Brune use with composed nonlinear solvers. 1799c79ef259SPeter Brune 1800c79ef259SPeter Brune Input Parameters: 1801c79ef259SPeter Brune + snes - the SNES context 1802bf388a1fSBarry Smith . SNESGSFunction - function evaluation routine 1803c79ef259SPeter Brune - ctx - [optional] user-defined context for private data for the 18040298fd71SBarry Smith smoother evaluation routine (may be NULL) 1805c79ef259SPeter Brune 1806c79ef259SPeter Brune Notes: 1807c79ef259SPeter Brune The GS routines are used by the composed nonlinear solver to generate 1808c79ef259SPeter Brune a problem appropriate update to the solution, particularly FAS. 1809c79ef259SPeter Brune 1810d28543b3SPeter Brune Level: intermediate 1811c79ef259SPeter Brune 1812d28543b3SPeter Brune .keywords: SNES, nonlinear, set, Gauss-Seidel 1813c79ef259SPeter Brune 1814c79ef259SPeter Brune .seealso: SNESGetFunction(), SNESComputeGS() 1815c79ef259SPeter Brune @*/ 1816bf388a1fSBarry Smith PetscErrorCode SNESSetGS(SNES snes,PetscErrorCode (*SNESGSFunction)(SNES,Vec,Vec,void*),void *ctx) 18176cab3a1bSJed Brown { 18186cab3a1bSJed Brown PetscErrorCode ierr; 18196cab3a1bSJed Brown DM dm; 18206cab3a1bSJed Brown 1821646217ecSPeter Brune PetscFunctionBegin; 18226cab3a1bSJed Brown PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 18236cab3a1bSJed Brown ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr); 1824bf388a1fSBarry Smith ierr = DMSNESSetGS(dm,SNESGSFunction,ctx);CHKERRQ(ierr); 1825646217ecSPeter Brune PetscFunctionReturn(0); 1826646217ecSPeter Brune } 1827646217ecSPeter Brune 1828d25893d9SBarry Smith #undef __FUNCT__ 18298b0a5094SBarry Smith #define __FUNCT__ "SNESPicardComputeFunction" 183082b59a81SJed Brown PETSC_EXTERN PetscErrorCode SNESPicardComputeFunction(SNES snes,Vec x,Vec f,void *ctx) 18318b0a5094SBarry Smith { 18328b0a5094SBarry Smith PetscErrorCode ierr; 1833e03ab78fSPeter Brune DM dm; 1834942e3340SBarry Smith DMSNES sdm; 18356cab3a1bSJed Brown 18368b0a5094SBarry Smith PetscFunctionBegin; 1837e03ab78fSPeter Brune ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr); 1838942e3340SBarry Smith ierr = DMGetDMSNES(dm,&sdm);CHKERRQ(ierr); 18398b0a5094SBarry Smith /* A(x)*x - b(x) */ 184022c6f798SBarry Smith if (sdm->ops->computepfunction) { 184122c6f798SBarry Smith ierr = (*sdm->ops->computepfunction)(snes,x,f,sdm->pctx);CHKERRQ(ierr); 184222c6f798SBarry Smith } else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE, "Must call SNESSetPicard() to provide Picard function."); 1843e03ab78fSPeter Brune 184422c6f798SBarry Smith if (sdm->ops->computepjacobian) { 184522c6f798SBarry Smith ierr = (*sdm->ops->computepjacobian)(snes,x,&snes->jacobian,&snes->jacobian_pre,&snes->matstruct,sdm->pctx);CHKERRQ(ierr); 184674e1e8c1SBarry Smith } else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE, "Must call SNESSetPicard() to provide Picard matrix."); 18478b0a5094SBarry Smith ierr = VecScale(f,-1.0);CHKERRQ(ierr); 184895eabcedSBarry Smith ierr = MatMultAdd(snes->jacobian,x,f,f);CHKERRQ(ierr); 18498b0a5094SBarry Smith PetscFunctionReturn(0); 18508b0a5094SBarry Smith } 18518b0a5094SBarry Smith 18528b0a5094SBarry Smith #undef __FUNCT__ 18538b0a5094SBarry Smith #define __FUNCT__ "SNESPicardComputeJacobian" 185482b59a81SJed Brown PETSC_EXTERN PetscErrorCode SNESPicardComputeJacobian(SNES snes,Vec x1,Mat *J,Mat *B,MatStructure *flag,void *ctx) 18558b0a5094SBarry Smith { 18568b0a5094SBarry Smith PetscFunctionBegin; 1857e03ab78fSPeter Brune /* the jacobian matrix should be pre-filled in SNESPicardComputeFunction */ 18588b0a5094SBarry Smith *flag = snes->matstruct; 18598b0a5094SBarry Smith PetscFunctionReturn(0); 18608b0a5094SBarry Smith } 18618b0a5094SBarry Smith 18628b0a5094SBarry Smith #undef __FUNCT__ 18638b0a5094SBarry Smith #define __FUNCT__ "SNESSetPicard" 18648b0a5094SBarry Smith /*@C 18650d04baf8SBarry Smith SNESSetPicard - Use SNES to solve the semilinear-system A(x) x = b(x) via a Picard type iteration (Picard linearization) 18668b0a5094SBarry Smith 18678b0a5094SBarry Smith Logically Collective on SNES 18688b0a5094SBarry Smith 18698b0a5094SBarry Smith Input Parameters: 18708b0a5094SBarry Smith + snes - the SNES context 18718b0a5094SBarry Smith . r - vector to store function value 1872bf388a1fSBarry Smith . SNESFunction - function evaluation routine 1873e5d3d808SBarry Smith . Amat - matrix with which A(x) x - b(x) is to be computed 1874e5d3d808SBarry Smith . Pmat - matrix from which preconditioner is computed (usually the same as Amat) 1875bf388a1fSBarry Smith . SNESJacobianFunction - function to compute matrix value 18768b0a5094SBarry Smith - ctx - [optional] user-defined context for private data for the 18770298fd71SBarry Smith function evaluation routine (may be NULL) 18788b0a5094SBarry Smith 18798b0a5094SBarry Smith Notes: 1880f450aa47SBarry 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 1881f450aa47SBarry 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. 1882f450aa47SBarry Smith 18838b0a5094SBarry Smith One can call SNESSetPicard() or SNESSetFunction() (and possibly SNESSetJacobian()) but cannot call both 18848b0a5094SBarry Smith 18858b0a5094SBarry 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} 18868b0a5094SBarry 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. 18878b0a5094SBarry Smith 18888b0a5094SBarry Smith Run with -snes_mf_operator to solve the system with Newton's method using A(x^{n}) to construct the preconditioner. 18898b0a5094SBarry Smith 18900d04baf8SBarry Smith We implement the defect correction form of the Picard iteration because it converges much more generally when inexact linear solvers are used then 18910d04baf8SBarry Smith the direct Picard iteration A(x^n) x^{n+1} = b(x^n) 18928b0a5094SBarry Smith 18938b0a5094SBarry 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 18948b0a5094SBarry 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 18958b0a5094SBarry Smith different please contact us at petsc-dev@mcs.anl.gov and we'll have an entirely new argument :-). 18968b0a5094SBarry Smith 1897f450aa47SBarry Smith Level: intermediate 18988b0a5094SBarry Smith 18998b0a5094SBarry Smith .keywords: SNES, nonlinear, set, function 19008b0a5094SBarry Smith 19010d04baf8SBarry Smith .seealso: SNESGetFunction(), SNESSetFunction(), SNESComputeFunction(), SNESSetJacobian(), SNESGetPicard(), SNESLineSearchPreCheckPicard() 19028b0a5094SBarry Smith @*/ 1903e5d3d808SBarry Smith PetscErrorCode SNESSetPicard(SNES snes,Vec r,PetscErrorCode (*SNESFunction)(SNES,Vec,Vec,void*),Mat Amat, Mat Pmat, PetscErrorCode (*SNESJacobianFunction)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void *ctx) 19048b0a5094SBarry Smith { 19058b0a5094SBarry Smith PetscErrorCode ierr; 1906e03ab78fSPeter Brune DM dm; 1907e03ab78fSPeter Brune 19088b0a5094SBarry Smith PetscFunctionBegin; 19098b0a5094SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 1910e03ab78fSPeter Brune ierr = SNESGetDM(snes, &dm);CHKERRQ(ierr); 1911bf388a1fSBarry Smith ierr = DMSNESSetPicard(dm,SNESFunction,SNESJacobianFunction,ctx);CHKERRQ(ierr); 19128b0a5094SBarry Smith ierr = SNESSetFunction(snes,r,SNESPicardComputeFunction,ctx);CHKERRQ(ierr); 1913e5d3d808SBarry Smith ierr = SNESSetJacobian(snes,Amat,Pmat,SNESPicardComputeJacobian,ctx);CHKERRQ(ierr); 19148b0a5094SBarry Smith PetscFunctionReturn(0); 19158b0a5094SBarry Smith } 19168b0a5094SBarry Smith 19177971a8bfSPeter Brune #undef __FUNCT__ 19187971a8bfSPeter Brune #define __FUNCT__ "SNESGetPicard" 19197971a8bfSPeter Brune /*@C 19207971a8bfSPeter Brune SNESGetPicard - Returns the context for the Picard iteration 19217971a8bfSPeter Brune 19227971a8bfSPeter Brune Not Collective, but Vec is parallel if SNES is parallel. Collective if Vec is requested, but has not been created yet. 19237971a8bfSPeter Brune 19247971a8bfSPeter Brune Input Parameter: 19257971a8bfSPeter Brune . snes - the SNES context 19267971a8bfSPeter Brune 19277971a8bfSPeter Brune Output Parameter: 19280298fd71SBarry Smith + r - the function (or NULL) 19290298fd71SBarry Smith . SNESFunction - the function (or NULL) 1930e4357dc4SBarry Smith . Amat - the matrix used to defined the operation A(x) x - b(x) (or NULL) 1931e4357dc4SBarry Smith . Pmat - the matrix from which the preconditioner will be constructed (or NULL) 19320298fd71SBarry Smith . SNESJacobianFunction - the function for matrix evaluation (or NULL) 19330298fd71SBarry Smith - ctx - the function context (or NULL) 19347971a8bfSPeter Brune 19357971a8bfSPeter Brune Level: advanced 19367971a8bfSPeter Brune 19377971a8bfSPeter Brune .keywords: SNES, nonlinear, get, function 19387971a8bfSPeter Brune 1939e4357dc4SBarry Smith .seealso: SNESSetPicard(), SNESGetFunction(), SNESGetJacobian(), SNESGetDM(), SNESFunction, SNESJacobianFunction 19407971a8bfSPeter Brune @*/ 1941e4357dc4SBarry Smith PetscErrorCode SNESGetPicard(SNES snes,Vec *r,PetscErrorCode (**SNESFunction)(SNES,Vec,Vec,void*),Mat *Amat, Mat *Pmat, PetscErrorCode (**SNESJacobianFunction)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void **ctx) 19427971a8bfSPeter Brune { 19437971a8bfSPeter Brune PetscErrorCode ierr; 19447971a8bfSPeter Brune DM dm; 19457971a8bfSPeter Brune 19467971a8bfSPeter Brune PetscFunctionBegin; 19477971a8bfSPeter Brune PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 19480298fd71SBarry Smith ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr); 1949e4357dc4SBarry Smith ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr); 19507971a8bfSPeter Brune ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr); 1951bf388a1fSBarry Smith ierr = DMSNESGetPicard(dm,SNESFunction,SNESJacobianFunction,ctx);CHKERRQ(ierr); 19527971a8bfSPeter Brune PetscFunctionReturn(0); 19537971a8bfSPeter Brune } 19547971a8bfSPeter Brune 19558b0a5094SBarry Smith #undef __FUNCT__ 1956d25893d9SBarry Smith #define __FUNCT__ "SNESSetComputeInitialGuess" 1957d25893d9SBarry Smith /*@C 1958d25893d9SBarry Smith SNESSetComputeInitialGuess - Sets a routine used to compute an initial guess for the problem 1959d25893d9SBarry Smith 1960d25893d9SBarry Smith Logically Collective on SNES 1961d25893d9SBarry Smith 1962d25893d9SBarry Smith Input Parameters: 1963d25893d9SBarry Smith + snes - the SNES context 1964d25893d9SBarry Smith . func - function evaluation routine 1965d25893d9SBarry Smith - ctx - [optional] user-defined context for private data for the 19660298fd71SBarry Smith function evaluation routine (may be NULL) 1967d25893d9SBarry Smith 1968d25893d9SBarry Smith Calling sequence of func: 1969d25893d9SBarry Smith $ func (SNES snes,Vec x,void *ctx); 1970d25893d9SBarry Smith 1971d25893d9SBarry Smith . f - function vector 1972d25893d9SBarry Smith - ctx - optional user-defined function context 1973d25893d9SBarry Smith 1974d25893d9SBarry Smith Level: intermediate 1975d25893d9SBarry Smith 1976d25893d9SBarry Smith .keywords: SNES, nonlinear, set, function 1977d25893d9SBarry Smith 1978d25893d9SBarry Smith .seealso: SNESGetFunction(), SNESComputeFunction(), SNESSetJacobian() 1979d25893d9SBarry Smith @*/ 1980d25893d9SBarry Smith PetscErrorCode SNESSetComputeInitialGuess(SNES snes,PetscErrorCode (*func)(SNES,Vec,void*),void *ctx) 1981d25893d9SBarry Smith { 1982d25893d9SBarry Smith PetscFunctionBegin; 1983d25893d9SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 1984d25893d9SBarry Smith if (func) snes->ops->computeinitialguess = func; 1985d25893d9SBarry Smith if (ctx) snes->initialguessP = ctx; 1986d25893d9SBarry Smith PetscFunctionReturn(0); 1987d25893d9SBarry Smith } 1988d25893d9SBarry Smith 19893ab0aad5SBarry Smith /* --------------------------------------------------------------- */ 19903ab0aad5SBarry Smith #undef __FUNCT__ 19911096aae1SMatthew Knepley #define __FUNCT__ "SNESGetRhs" 19921096aae1SMatthew Knepley /*@C 19931096aae1SMatthew Knepley SNESGetRhs - Gets the vector for solving F(x) = rhs. If rhs is not set 19941096aae1SMatthew Knepley it assumes a zero right hand side. 19951096aae1SMatthew Knepley 19963f9fe445SBarry Smith Logically Collective on SNES 19971096aae1SMatthew Knepley 19981096aae1SMatthew Knepley Input Parameter: 19991096aae1SMatthew Knepley . snes - the SNES context 20001096aae1SMatthew Knepley 20011096aae1SMatthew Knepley Output Parameter: 20020298fd71SBarry Smith . rhs - the right hand side vector or NULL if the right hand side vector is null 20031096aae1SMatthew Knepley 20041096aae1SMatthew Knepley Level: intermediate 20051096aae1SMatthew Knepley 20061096aae1SMatthew Knepley .keywords: SNES, nonlinear, get, function, right hand side 20071096aae1SMatthew Knepley 200885385478SLisandro Dalcin .seealso: SNESGetSolution(), SNESGetFunction(), SNESComputeFunction(), SNESSetJacobian(), SNESSetFunction() 20091096aae1SMatthew Knepley @*/ 20107087cfbeSBarry Smith PetscErrorCode SNESGetRhs(SNES snes,Vec *rhs) 20111096aae1SMatthew Knepley { 20121096aae1SMatthew Knepley PetscFunctionBegin; 20130700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 20141096aae1SMatthew Knepley PetscValidPointer(rhs,2); 201585385478SLisandro Dalcin *rhs = snes->vec_rhs; 20161096aae1SMatthew Knepley PetscFunctionReturn(0); 20171096aae1SMatthew Knepley } 20181096aae1SMatthew Knepley 20191096aae1SMatthew Knepley #undef __FUNCT__ 20204a2ae208SSatish Balay #define __FUNCT__ "SNESComputeFunction" 20219b94acceSBarry Smith /*@ 2022bf388a1fSBarry Smith SNESComputeFunction - Calls the function that has been set with SNESSetFunction(). 20239b94acceSBarry Smith 2024c7afd0dbSLois Curfman McInnes Collective on SNES 2025c7afd0dbSLois Curfman McInnes 20269b94acceSBarry Smith Input Parameters: 2027c7afd0dbSLois Curfman McInnes + snes - the SNES context 2028c7afd0dbSLois Curfman McInnes - x - input vector 20299b94acceSBarry Smith 20309b94acceSBarry Smith Output Parameter: 20313638b69dSLois Curfman McInnes . y - function vector, as set by SNESSetFunction() 20329b94acceSBarry Smith 20331bffabb2SLois Curfman McInnes Notes: 203436851e7fSLois Curfman McInnes SNESComputeFunction() is typically used within nonlinear solvers 203536851e7fSLois Curfman McInnes implementations, so most users would not generally call this routine 203636851e7fSLois Curfman McInnes themselves. 203736851e7fSLois Curfman McInnes 203836851e7fSLois Curfman McInnes Level: developer 203936851e7fSLois Curfman McInnes 20409b94acceSBarry Smith .keywords: SNES, nonlinear, compute, function 20419b94acceSBarry Smith 2042a86d99e1SLois Curfman McInnes .seealso: SNESSetFunction(), SNESGetFunction() 20439b94acceSBarry Smith @*/ 20447087cfbeSBarry Smith PetscErrorCode SNESComputeFunction(SNES snes,Vec x,Vec y) 20459b94acceSBarry Smith { 2046dfbe8321SBarry Smith PetscErrorCode ierr; 20476cab3a1bSJed Brown DM dm; 2048942e3340SBarry Smith DMSNES sdm; 20499b94acceSBarry Smith 20503a40ed3dSBarry Smith PetscFunctionBegin; 20510700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 20520700a824SBarry Smith PetscValidHeaderSpecific(x,VEC_CLASSID,2); 20530700a824SBarry Smith PetscValidHeaderSpecific(y,VEC_CLASSID,3); 2054c9780b6fSBarry Smith PetscCheckSameComm(snes,1,x,2); 2055c9780b6fSBarry Smith PetscCheckSameComm(snes,1,y,3); 205662796dfbSBarry Smith ierr = VecValidValues(x,2,PETSC_TRUE);CHKERRQ(ierr); 2057184914b5SBarry Smith 20586cab3a1bSJed Brown ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr); 2059942e3340SBarry Smith ierr = DMGetDMSNES(dm,&sdm);CHKERRQ(ierr); 206032f3f7c2SPeter Brune if (sdm->ops->computefunction) { 2061ccf3c845SPeter Brune ierr = PetscLogEventBegin(SNES_FunctionEval,snes,x,y,0);CHKERRQ(ierr); 2062d64ed03dSBarry Smith PetscStackPush("SNES user function"); 206322c6f798SBarry Smith ierr = (*sdm->ops->computefunction)(snes,x,y,sdm->functionctx);CHKERRQ(ierr); 2064d64ed03dSBarry Smith PetscStackPop; 2065ccf3c845SPeter Brune ierr = PetscLogEventEnd(SNES_FunctionEval,snes,x,y,0);CHKERRQ(ierr); 2066c90fad12SPeter Brune } else if (snes->vec_rhs) { 2067c90fad12SPeter Brune ierr = MatMult(snes->jacobian, x, y);CHKERRQ(ierr); 2068644e2e5bSBarry Smith } else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE, "Must call SNESSetFunction() or SNESSetDM() before SNESComputeFunction(), likely called from SNESSolve()."); 206985385478SLisandro Dalcin if (snes->vec_rhs) { 207085385478SLisandro Dalcin ierr = VecAXPY(y,-1.0,snes->vec_rhs);CHKERRQ(ierr); 20713ab0aad5SBarry Smith } 2072ae3c334cSLois Curfman McInnes snes->nfuncs++; 207362796dfbSBarry Smith ierr = VecValidValues(y,3,PETSC_FALSE);CHKERRQ(ierr); 20743a40ed3dSBarry Smith PetscFunctionReturn(0); 20759b94acceSBarry Smith } 20769b94acceSBarry Smith 20774a2ae208SSatish Balay #undef __FUNCT__ 2078646217ecSPeter Brune #define __FUNCT__ "SNESComputeGS" 2079c79ef259SPeter Brune /*@ 2080bf388a1fSBarry Smith SNESComputeGS - Calls the Gauss-Seidel function that has been set with SNESSetGS(). 2081c79ef259SPeter Brune 2082c79ef259SPeter Brune Collective on SNES 2083c79ef259SPeter Brune 2084c79ef259SPeter Brune Input Parameters: 2085c79ef259SPeter Brune + snes - the SNES context 2086c79ef259SPeter Brune . x - input vector 2087c79ef259SPeter Brune - b - rhs vector 2088c79ef259SPeter Brune 2089c79ef259SPeter Brune Output Parameter: 2090c79ef259SPeter Brune . x - new solution vector 2091c79ef259SPeter Brune 2092c79ef259SPeter Brune Notes: 2093c79ef259SPeter Brune SNESComputeGS() is typically used within composed nonlinear solver 2094c79ef259SPeter Brune implementations, so most users would not generally call this routine 2095c79ef259SPeter Brune themselves. 2096c79ef259SPeter Brune 2097c79ef259SPeter Brune Level: developer 2098c79ef259SPeter Brune 2099c79ef259SPeter Brune .keywords: SNES, nonlinear, compute, function 2100c79ef259SPeter Brune 2101c79ef259SPeter Brune .seealso: SNESSetGS(), SNESComputeFunction() 2102c79ef259SPeter Brune @*/ 2103646217ecSPeter Brune PetscErrorCode SNESComputeGS(SNES snes,Vec b,Vec x) 2104646217ecSPeter Brune { 2105646217ecSPeter Brune PetscErrorCode ierr; 21066cab3a1bSJed Brown DM dm; 2107942e3340SBarry Smith DMSNES sdm; 2108646217ecSPeter Brune 2109646217ecSPeter Brune PetscFunctionBegin; 2110646217ecSPeter Brune PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 2111646217ecSPeter Brune PetscValidHeaderSpecific(x,VEC_CLASSID,2); 2112646217ecSPeter Brune if (b) PetscValidHeaderSpecific(b,VEC_CLASSID,3); 2113646217ecSPeter Brune PetscCheckSameComm(snes,1,x,2); 2114646217ecSPeter Brune if (b) PetscCheckSameComm(snes,1,b,3); 211562796dfbSBarry Smith if (b) {ierr = VecValidValues(b,2,PETSC_TRUE);CHKERRQ(ierr);} 2116701cf23dSPeter Brune ierr = PetscLogEventBegin(SNES_GSEval,snes,x,b,0);CHKERRQ(ierr); 21176cab3a1bSJed Brown ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr); 2118942e3340SBarry Smith ierr = DMGetDMSNES(dm,&sdm);CHKERRQ(ierr); 211922c6f798SBarry Smith if (sdm->ops->computegs) { 2120646217ecSPeter Brune PetscStackPush("SNES user GS"); 212122c6f798SBarry Smith ierr = (*sdm->ops->computegs)(snes,x,b,sdm->gsctx);CHKERRQ(ierr); 2122646217ecSPeter Brune PetscStackPop; 2123646217ecSPeter Brune } else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE, "Must call SNESSetGS() before SNESComputeGS(), likely called from SNESSolve()."); 2124701cf23dSPeter Brune ierr = PetscLogEventEnd(SNES_GSEval,snes,x,b,0);CHKERRQ(ierr); 212562796dfbSBarry Smith ierr = VecValidValues(x,3,PETSC_FALSE);CHKERRQ(ierr); 2126646217ecSPeter Brune PetscFunctionReturn(0); 2127646217ecSPeter Brune } 2128646217ecSPeter Brune 2129646217ecSPeter Brune #undef __FUNCT__ 21304a2ae208SSatish Balay #define __FUNCT__ "SNESComputeJacobian" 213162fef451SLois Curfman McInnes /*@ 2132bf388a1fSBarry Smith SNESComputeJacobian - Computes the Jacobian matrix that has been set with SNESSetJacobian(). 213362fef451SLois Curfman McInnes 2134c7afd0dbSLois Curfman McInnes Collective on SNES and Mat 2135c7afd0dbSLois Curfman McInnes 213662fef451SLois Curfman McInnes Input Parameters: 2137c7afd0dbSLois Curfman McInnes + snes - the SNES context 2138c7afd0dbSLois Curfman McInnes - x - input vector 213962fef451SLois Curfman McInnes 214062fef451SLois Curfman McInnes Output Parameters: 2141c7afd0dbSLois Curfman McInnes + A - Jacobian matrix 214262fef451SLois Curfman McInnes . B - optional preconditioning matrix 21432b668275SBarry Smith - flag - flag indicating matrix structure (one of, SAME_NONZERO_PATTERN,DIFFERENT_NONZERO_PATTERN,SAME_PRECONDITIONER) 2144fee21e36SBarry Smith 2145e35cf81dSBarry Smith Options Database Keys: 2146e35cf81dSBarry Smith + -snes_lag_preconditioner <lag> 2147693365a8SJed Brown . -snes_lag_jacobian <lag> 2148693365a8SJed Brown . -snes_compare_explicit - Compare the computed Jacobian to the finite difference Jacobian and output the differences 2149693365a8SJed Brown . -snes_compare_explicit_draw - Compare the computed Jacobian to the finite difference Jacobian and draw the result 2150693365a8SJed Brown . -snes_compare_explicit_contour - Compare the computed Jacobian to the finite difference Jacobian and draw a contour plot with the result 21514c30e9fbSJed Brown . -snes_compare_operator - Make the comparison options above use the operator instead of the preconditioning matrix 2152c01495d3SJed Brown . -snes_compare_coloring - Compute the finite differece Jacobian using coloring and display norms of difference 2153c01495d3SJed Brown . -snes_compare_coloring_display - Compute the finite differece Jacobian using coloring and display verbose differences 2154c01495d3SJed Brown . -snes_compare_coloring_threshold - Display only those matrix entries that differ by more than a given threshold 2155c01495d3SJed Brown . -snes_compare_coloring_threshold_atol - Absolute tolerance for difference in matrix entries to be displayed by -snes_compare_coloring_threshold 2156c01495d3SJed Brown . -snes_compare_coloring_threshold_rtol - Relative tolerance for difference in matrix entries to be displayed by -snes_compare_coloring_threshold 21574c30e9fbSJed Brown . -snes_compare_coloring_draw - Compute the finite differece Jacobian using coloring and draw differences 2158c01495d3SJed Brown - -snes_compare_coloring_draw_contour - Compute the finite differece Jacobian using coloring and show contours of matrices and differences 2159c01495d3SJed Brown 2160e35cf81dSBarry Smith 216162fef451SLois Curfman McInnes Notes: 216262fef451SLois Curfman McInnes Most users should not need to explicitly call this routine, as it 216362fef451SLois Curfman McInnes is used internally within the nonlinear solvers. 216462fef451SLois Curfman McInnes 216594b7f48cSBarry Smith See KSPSetOperators() for important information about setting the 2166dc5a77f8SLois Curfman McInnes flag parameter. 216762fef451SLois Curfman McInnes 216836851e7fSLois Curfman McInnes Level: developer 216936851e7fSLois Curfman McInnes 217062fef451SLois Curfman McInnes .keywords: SNES, compute, Jacobian, matrix 217162fef451SLois Curfman McInnes 2172e35cf81dSBarry Smith .seealso: SNESSetJacobian(), KSPSetOperators(), MatStructure, SNESSetLagPreconditioner(), SNESSetLagJacobian() 217362fef451SLois Curfman McInnes @*/ 21747087cfbeSBarry Smith PetscErrorCode SNESComputeJacobian(SNES snes,Vec X,Mat *A,Mat *B,MatStructure *flg) 21759b94acceSBarry Smith { 2176dfbe8321SBarry Smith PetscErrorCode ierr; 2177ace3abfcSBarry Smith PetscBool flag; 21786cab3a1bSJed Brown DM dm; 2179942e3340SBarry Smith DMSNES sdm; 21803a40ed3dSBarry Smith 21813a40ed3dSBarry Smith PetscFunctionBegin; 21820700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 21830700a824SBarry Smith PetscValidHeaderSpecific(X,VEC_CLASSID,2); 21844482741eSBarry Smith PetscValidPointer(flg,5); 2185c9780b6fSBarry Smith PetscCheckSameComm(snes,1,X,2); 218662796dfbSBarry Smith ierr = VecValidValues(X,2,PETSC_TRUE);CHKERRQ(ierr); 21876cab3a1bSJed Brown ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr); 2188942e3340SBarry Smith ierr = DMGetDMSNES(dm,&sdm);CHKERRQ(ierr); 21893232da50SPeter Brune 2190ce94432eSBarry Smith if (!sdm->ops->computejacobian) SETERRQ(PetscObjectComm((PetscObject)snes),PETSC_ERR_USER,"Must call SNESSetJacobian(), DMSNESSetJacobian(), DMDASNESSetJacobianLocal(), etc"); 2191ebd3b9afSBarry Smith 2192ebd3b9afSBarry Smith /* make sure that MatAssemblyBegin/End() is called on A matrix if it is matrix free */ 2193ebd3b9afSBarry Smith 2194fe3ffe1eSBarry Smith if (snes->lagjacobian == -2) { 2195fe3ffe1eSBarry Smith snes->lagjacobian = -1; 2196f5af7f23SKarl Rupp 2197fe3ffe1eSBarry Smith ierr = PetscInfo(snes,"Recomputing Jacobian/preconditioner because lag is -2 (means compute Jacobian, but then never again) \n");CHKERRQ(ierr); 2198fe3ffe1eSBarry Smith } else if (snes->lagjacobian == -1) { 2199e35cf81dSBarry Smith *flg = SAME_PRECONDITIONER; 2200e35cf81dSBarry Smith ierr = PetscInfo(snes,"Reusing Jacobian/preconditioner because lag is -1\n");CHKERRQ(ierr); 2201251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)*A,MATMFFD,&flag);CHKERRQ(ierr); 2202ebd3b9afSBarry Smith if (flag) { 2203ebd3b9afSBarry Smith ierr = MatAssemblyBegin(*A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 2204ebd3b9afSBarry Smith ierr = MatAssemblyEnd(*A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 2205ebd3b9afSBarry Smith } 2206e35cf81dSBarry Smith PetscFunctionReturn(0); 220737ec4e1aSPeter Brune } else if (snes->lagjacobian > 1 && (snes->iter + snes->jac_iter) % snes->lagjacobian) { 2208e35cf81dSBarry Smith *flg = SAME_PRECONDITIONER; 2209e35cf81dSBarry Smith ierr = PetscInfo2(snes,"Reusing Jacobian/preconditioner because lag is %D and SNES iteration is %D\n",snes->lagjacobian,snes->iter);CHKERRQ(ierr); 2210251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)*A,MATMFFD,&flag);CHKERRQ(ierr); 2211ebd3b9afSBarry Smith if (flag) { 2212ebd3b9afSBarry Smith ierr = MatAssemblyBegin(*A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 2213ebd3b9afSBarry Smith ierr = MatAssemblyEnd(*A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 2214ebd3b9afSBarry Smith } 2215e35cf81dSBarry Smith PetscFunctionReturn(0); 2216e35cf81dSBarry Smith } 2217d728fb7dSPeter Brune if (snes->pc && snes->pcside == PC_LEFT) { 2218d728fb7dSPeter Brune ierr = MatAssemblyBegin(*A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 2219d728fb7dSPeter Brune ierr = MatAssemblyEnd(*A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 2220d728fb7dSPeter Brune PetscFunctionReturn(0); 2221d728fb7dSPeter Brune } 2222e35cf81dSBarry Smith 2223c4fc05e7SBarry Smith *flg = DIFFERENT_NONZERO_PATTERN; 2224e35cf81dSBarry Smith ierr = PetscLogEventBegin(SNES_JacobianEval,snes,X,*A,*B);CHKERRQ(ierr); 22253232da50SPeter Brune 2226d64ed03dSBarry Smith PetscStackPush("SNES user Jacobian function"); 222722c6f798SBarry Smith ierr = (*sdm->ops->computejacobian)(snes,X,A,B,flg,sdm->jacobianctx);CHKERRQ(ierr); 2228d64ed03dSBarry Smith PetscStackPop; 22293232da50SPeter Brune 2230d5ba7fb7SMatthew Knepley ierr = PetscLogEventEnd(SNES_JacobianEval,snes,X,*A,*B);CHKERRQ(ierr); 2231a8054027SBarry Smith 22323b4f5425SBarry Smith if (snes->lagpreconditioner == -2) { 22333b4f5425SBarry Smith ierr = PetscInfo(snes,"Rebuilding preconditioner exactly once since lag is -2\n");CHKERRQ(ierr); 2234f5af7f23SKarl Rupp 22353b4f5425SBarry Smith snes->lagpreconditioner = -1; 22363b4f5425SBarry Smith } else if (snes->lagpreconditioner == -1) { 2237a8054027SBarry Smith *flg = SAME_PRECONDITIONER; 2238a8054027SBarry Smith ierr = PetscInfo(snes,"Reusing preconditioner because lag is -1\n");CHKERRQ(ierr); 223937ec4e1aSPeter Brune } else if (snes->lagpreconditioner > 1 && (snes->iter + snes->pre_iter) % snes->lagpreconditioner) { 2240a8054027SBarry Smith *flg = SAME_PRECONDITIONER; 2241a8054027SBarry Smith ierr = PetscInfo2(snes,"Reusing preconditioner because lag is %D and SNES iteration is %D\n",snes->lagpreconditioner,snes->iter);CHKERRQ(ierr); 2242a8054027SBarry Smith } 2243a8054027SBarry Smith 22446d84be18SBarry Smith /* make sure user returned a correct Jacobian and preconditioner */ 22450700a824SBarry Smith /* PetscValidHeaderSpecific(*A,MAT_CLASSID,3); 22460700a824SBarry Smith PetscValidHeaderSpecific(*B,MAT_CLASSID,4); */ 2247693365a8SJed Brown { 2248693365a8SJed Brown PetscBool flag = PETSC_FALSE,flag_draw = PETSC_FALSE,flag_contour = PETSC_FALSE,flag_operator = PETSC_FALSE; 22490298fd71SBarry Smith ierr = PetscOptionsGetBool(((PetscObject)snes)->prefix,"-snes_compare_explicit",&flag,NULL);CHKERRQ(ierr); 22500298fd71SBarry Smith ierr = PetscOptionsGetBool(((PetscObject)snes)->prefix,"-snes_compare_explicit_draw",&flag_draw,NULL);CHKERRQ(ierr); 22510298fd71SBarry Smith ierr = PetscOptionsGetBool(((PetscObject)snes)->prefix,"-snes_compare_explicit_draw_contour",&flag_contour,NULL);CHKERRQ(ierr); 22520298fd71SBarry Smith ierr = PetscOptionsGetBool(((PetscObject)snes)->prefix,"-snes_compare_operator",&flag_operator,NULL);CHKERRQ(ierr); 2253693365a8SJed Brown if (flag || flag_draw || flag_contour) { 22540298fd71SBarry Smith Mat Bexp_mine = NULL,Bexp,FDexp; 2255693365a8SJed Brown MatStructure mstruct; 2256693365a8SJed Brown PetscViewer vdraw,vstdout; 22576b3a5b13SJed Brown PetscBool flg; 2258693365a8SJed Brown if (flag_operator) { 2259693365a8SJed Brown ierr = MatComputeExplicitOperator(*A,&Bexp_mine);CHKERRQ(ierr); 2260693365a8SJed Brown Bexp = Bexp_mine; 2261693365a8SJed Brown } else { 2262693365a8SJed Brown /* See if the preconditioning matrix can be viewed and added directly */ 2263251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompareAny((PetscObject)*B,&flg,MATSEQAIJ,MATMPIAIJ,MATSEQDENSE,MATMPIDENSE,MATSEQBAIJ,MATMPIBAIJ,MATSEQSBAIJ,MATMPIBAIJ,"");CHKERRQ(ierr); 2264693365a8SJed Brown if (flg) Bexp = *B; 2265693365a8SJed Brown else { 2266693365a8SJed Brown /* If the "preconditioning" matrix is itself MATSHELL or some other type without direct support */ 2267693365a8SJed Brown ierr = MatComputeExplicitOperator(*B,&Bexp_mine);CHKERRQ(ierr); 2268693365a8SJed Brown Bexp = Bexp_mine; 2269693365a8SJed Brown } 2270693365a8SJed Brown } 2271693365a8SJed Brown ierr = MatConvert(Bexp,MATSAME,MAT_INITIAL_MATRIX,&FDexp);CHKERRQ(ierr); 22728d359177SBarry Smith ierr = SNESComputeJacobianDefault(snes,X,&FDexp,&FDexp,&mstruct,NULL);CHKERRQ(ierr); 2273ce94432eSBarry Smith ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)snes),&vstdout);CHKERRQ(ierr); 2274693365a8SJed Brown if (flag_draw || flag_contour) { 2275ce94432eSBarry Smith ierr = PetscViewerDrawOpen(PetscObjectComm((PetscObject)snes),0,"Explicit Jacobians",PETSC_DECIDE,PETSC_DECIDE,300,300,&vdraw);CHKERRQ(ierr); 2276693365a8SJed Brown if (flag_contour) {ierr = PetscViewerPushFormat(vdraw,PETSC_VIEWER_DRAW_CONTOUR);CHKERRQ(ierr);} 22770298fd71SBarry Smith } else vdraw = NULL; 2278693365a8SJed Brown ierr = PetscViewerASCIIPrintf(vstdout,"Explicit %s\n",flag_operator ? "Jacobian" : "preconditioning Jacobian");CHKERRQ(ierr); 2279693365a8SJed Brown if (flag) {ierr = MatView(Bexp,vstdout);CHKERRQ(ierr);} 2280693365a8SJed Brown if (vdraw) {ierr = MatView(Bexp,vdraw);CHKERRQ(ierr);} 2281693365a8SJed Brown ierr = PetscViewerASCIIPrintf(vstdout,"Finite difference Jacobian\n");CHKERRQ(ierr); 2282693365a8SJed Brown if (flag) {ierr = MatView(FDexp,vstdout);CHKERRQ(ierr);} 2283693365a8SJed Brown if (vdraw) {ierr = MatView(FDexp,vdraw);CHKERRQ(ierr);} 2284693365a8SJed Brown ierr = MatAYPX(FDexp,-1.0,Bexp,SAME_NONZERO_PATTERN);CHKERRQ(ierr); 2285693365a8SJed Brown ierr = PetscViewerASCIIPrintf(vstdout,"User-provided matrix minus finite difference Jacobian\n");CHKERRQ(ierr); 2286693365a8SJed Brown if (flag) {ierr = MatView(FDexp,vstdout);CHKERRQ(ierr);} 2287693365a8SJed Brown if (vdraw) { /* Always use contour for the difference */ 2288693365a8SJed Brown ierr = PetscViewerPushFormat(vdraw,PETSC_VIEWER_DRAW_CONTOUR);CHKERRQ(ierr); 2289693365a8SJed Brown ierr = MatView(FDexp,vdraw);CHKERRQ(ierr); 2290693365a8SJed Brown ierr = PetscViewerPopFormat(vdraw);CHKERRQ(ierr); 2291693365a8SJed Brown } 2292693365a8SJed Brown if (flag_contour) {ierr = PetscViewerPopFormat(vdraw);CHKERRQ(ierr);} 2293693365a8SJed Brown ierr = PetscViewerDestroy(&vdraw);CHKERRQ(ierr); 2294693365a8SJed Brown ierr = MatDestroy(&Bexp_mine);CHKERRQ(ierr); 2295693365a8SJed Brown ierr = MatDestroy(&FDexp);CHKERRQ(ierr); 2296693365a8SJed Brown } 2297693365a8SJed Brown } 22984c30e9fbSJed Brown { 22996719d8e4SJed Brown PetscBool flag = PETSC_FALSE,flag_display = PETSC_FALSE,flag_draw = PETSC_FALSE,flag_contour = PETSC_FALSE,flag_threshold = PETSC_FALSE; 23006719d8e4SJed Brown PetscReal threshold_atol = PETSC_SQRT_MACHINE_EPSILON,threshold_rtol = 10*PETSC_SQRT_MACHINE_EPSILON; 23010298fd71SBarry Smith ierr = PetscOptionsGetBool(((PetscObject)snes)->prefix,"-snes_compare_coloring",&flag,NULL);CHKERRQ(ierr); 23020298fd71SBarry Smith ierr = PetscOptionsGetBool(((PetscObject)snes)->prefix,"-snes_compare_coloring_display",&flag_display,NULL);CHKERRQ(ierr); 23030298fd71SBarry Smith ierr = PetscOptionsGetBool(((PetscObject)snes)->prefix,"-snes_compare_coloring_draw",&flag_draw,NULL);CHKERRQ(ierr); 23040298fd71SBarry Smith ierr = PetscOptionsGetBool(((PetscObject)snes)->prefix,"-snes_compare_coloring_draw_contour",&flag_contour,NULL);CHKERRQ(ierr); 23050298fd71SBarry Smith ierr = PetscOptionsGetBool(((PetscObject)snes)->prefix,"-snes_compare_coloring_threshold",&flag_threshold,NULL);CHKERRQ(ierr); 23060298fd71SBarry Smith ierr = PetscOptionsGetReal(((PetscObject)snes)->prefix,"-snes_compare_coloring_threshold_rtol",&threshold_rtol,NULL);CHKERRQ(ierr); 23070298fd71SBarry Smith ierr = PetscOptionsGetReal(((PetscObject)snes)->prefix,"-snes_compare_coloring_threshold_atol",&threshold_atol,NULL);CHKERRQ(ierr); 23086719d8e4SJed Brown if (flag || flag_display || flag_draw || flag_contour || flag_threshold) { 23094c30e9fbSJed Brown Mat Bfd; 23104c30e9fbSJed Brown MatStructure mstruct; 23114c30e9fbSJed Brown PetscViewer vdraw,vstdout; 23124c30e9fbSJed Brown ISColoring iscoloring; 23134c30e9fbSJed Brown MatFDColoring matfdcoloring; 23144c30e9fbSJed Brown PetscErrorCode (*func)(SNES,Vec,Vec,void*); 23154c30e9fbSJed Brown void *funcctx; 23166719d8e4SJed Brown PetscReal norm1,norm2,normmax; 23174c30e9fbSJed Brown 23184c30e9fbSJed Brown ierr = MatDuplicate(*B,MAT_DO_NOT_COPY_VALUES,&Bfd);CHKERRQ(ierr); 23194c30e9fbSJed Brown ierr = MatGetColoring(Bfd,MATCOLORINGSL,&iscoloring);CHKERRQ(ierr); 23204c30e9fbSJed Brown ierr = MatFDColoringCreate(Bfd,iscoloring,&matfdcoloring);CHKERRQ(ierr); 2321*f86b9fbaSHong Zhang ierr = MatFDColoringSetFromOptions(matfdcoloring);CHKERRQ(ierr); 2322*f86b9fbaSHong Zhang ierr = MatFDColoringSetUp(Bfd,iscoloring,matfdcoloring);CHKERRQ(ierr); 23234c30e9fbSJed Brown ierr = ISColoringDestroy(&iscoloring);CHKERRQ(ierr); 23244c30e9fbSJed Brown 23254c30e9fbSJed Brown /* This method of getting the function is currently unreliable since it doesn't work for DM local functions. */ 23260298fd71SBarry Smith ierr = SNESGetFunction(snes,NULL,&func,&funcctx);CHKERRQ(ierr); 23274c30e9fbSJed Brown ierr = MatFDColoringSetFunction(matfdcoloring,(PetscErrorCode (*)(void))func,funcctx);CHKERRQ(ierr); 23284c30e9fbSJed Brown ierr = PetscObjectSetOptionsPrefix((PetscObject)matfdcoloring,((PetscObject)snes)->prefix);CHKERRQ(ierr); 23294c30e9fbSJed Brown ierr = PetscObjectAppendOptionsPrefix((PetscObject)matfdcoloring,"coloring_");CHKERRQ(ierr); 23304c30e9fbSJed Brown ierr = MatFDColoringSetFromOptions(matfdcoloring);CHKERRQ(ierr); 23314c30e9fbSJed Brown ierr = MatFDColoringApply(Bfd,matfdcoloring,X,&mstruct,snes);CHKERRQ(ierr); 23324c30e9fbSJed Brown ierr = MatFDColoringDestroy(&matfdcoloring);CHKERRQ(ierr); 23334c30e9fbSJed Brown 2334ce94432eSBarry Smith ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)snes),&vstdout);CHKERRQ(ierr); 23354c30e9fbSJed Brown if (flag_draw || flag_contour) { 2336ce94432eSBarry Smith ierr = PetscViewerDrawOpen(PetscObjectComm((PetscObject)snes),0,"Colored Jacobians",PETSC_DECIDE,PETSC_DECIDE,300,300,&vdraw);CHKERRQ(ierr); 23374c30e9fbSJed Brown if (flag_contour) {ierr = PetscViewerPushFormat(vdraw,PETSC_VIEWER_DRAW_CONTOUR);CHKERRQ(ierr);} 23380298fd71SBarry Smith } else vdraw = NULL; 23394c30e9fbSJed Brown ierr = PetscViewerASCIIPrintf(vstdout,"Explicit preconditioning Jacobian\n");CHKERRQ(ierr); 23406719d8e4SJed Brown if (flag_display) {ierr = MatView(*B,vstdout);CHKERRQ(ierr);} 23414c30e9fbSJed Brown if (vdraw) {ierr = MatView(*B,vdraw);CHKERRQ(ierr);} 23424c30e9fbSJed Brown ierr = PetscViewerASCIIPrintf(vstdout,"Colored Finite difference Jacobian\n");CHKERRQ(ierr); 23436719d8e4SJed Brown if (flag_display) {ierr = MatView(Bfd,vstdout);CHKERRQ(ierr);} 23444c30e9fbSJed Brown if (vdraw) {ierr = MatView(Bfd,vdraw);CHKERRQ(ierr);} 23454c30e9fbSJed Brown ierr = MatAYPX(Bfd,-1.0,*B,SAME_NONZERO_PATTERN);CHKERRQ(ierr); 23464c30e9fbSJed Brown ierr = MatNorm(Bfd,NORM_1,&norm1);CHKERRQ(ierr); 23476719d8e4SJed Brown ierr = MatNorm(Bfd,NORM_FROBENIUS,&norm2);CHKERRQ(ierr); 23484c30e9fbSJed Brown ierr = MatNorm(Bfd,NORM_MAX,&normmax);CHKERRQ(ierr); 23496719d8e4SJed Brown ierr = PetscViewerASCIIPrintf(vstdout,"User-provided matrix minus finite difference Jacobian, norm1=%G normFrob=%G normmax=%G\n",norm1,norm2,normmax);CHKERRQ(ierr); 23506719d8e4SJed Brown if (flag_display) {ierr = MatView(Bfd,vstdout);CHKERRQ(ierr);} 23514c30e9fbSJed Brown if (vdraw) { /* Always use contour for the difference */ 23524c30e9fbSJed Brown ierr = PetscViewerPushFormat(vdraw,PETSC_VIEWER_DRAW_CONTOUR);CHKERRQ(ierr); 23534c30e9fbSJed Brown ierr = MatView(Bfd,vdraw);CHKERRQ(ierr); 23544c30e9fbSJed Brown ierr = PetscViewerPopFormat(vdraw);CHKERRQ(ierr); 23554c30e9fbSJed Brown } 23564c30e9fbSJed Brown if (flag_contour) {ierr = PetscViewerPopFormat(vdraw);CHKERRQ(ierr);} 23576719d8e4SJed Brown 23586719d8e4SJed Brown if (flag_threshold) { 23596719d8e4SJed Brown PetscInt bs,rstart,rend,i; 23606719d8e4SJed Brown ierr = MatGetBlockSize(*B,&bs);CHKERRQ(ierr); 23616719d8e4SJed Brown ierr = MatGetOwnershipRange(*B,&rstart,&rend);CHKERRQ(ierr); 23626719d8e4SJed Brown for (i=rstart; i<rend; i++) { 23636719d8e4SJed Brown const PetscScalar *ba,*ca; 23646719d8e4SJed Brown const PetscInt *bj,*cj; 23656719d8e4SJed Brown PetscInt bn,cn,j,maxentrycol = -1,maxdiffcol = -1,maxrdiffcol = -1; 23666719d8e4SJed Brown PetscReal maxentry = 0,maxdiff = 0,maxrdiff = 0; 23676719d8e4SJed Brown ierr = MatGetRow(*B,i,&bn,&bj,&ba);CHKERRQ(ierr); 23686719d8e4SJed Brown ierr = MatGetRow(Bfd,i,&cn,&cj,&ca);CHKERRQ(ierr); 23696719d8e4SJed Brown if (bn != cn) SETERRQ(((PetscObject)*A)->comm,PETSC_ERR_PLIB,"Unexpected different nonzero pattern in -snes_compare_coloring_threshold"); 23706719d8e4SJed Brown for (j=0; j<bn; j++) { 23716719d8e4SJed Brown PetscReal rdiff = PetscAbsScalar(ca[j]) / (threshold_atol + threshold_rtol*PetscAbsScalar(ba[j])); 23726719d8e4SJed Brown if (PetscAbsScalar(ba[j]) > PetscAbs(maxentry)) { 23736719d8e4SJed Brown maxentrycol = bj[j]; 23746719d8e4SJed Brown maxentry = PetscRealPart(ba[j]); 23756719d8e4SJed Brown } 23766719d8e4SJed Brown if (PetscAbsScalar(ca[j]) > PetscAbs(maxdiff)) { 23776719d8e4SJed Brown maxdiffcol = bj[j]; 23786719d8e4SJed Brown maxdiff = PetscRealPart(ca[j]); 23796719d8e4SJed Brown } 23806719d8e4SJed Brown if (rdiff > maxrdiff) { 23816719d8e4SJed Brown maxrdiffcol = bj[j]; 23826719d8e4SJed Brown maxrdiff = rdiff; 23836719d8e4SJed Brown } 23846719d8e4SJed Brown } 23856719d8e4SJed Brown if (maxrdiff > 1) { 23866719d8e4SJed 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); 23876719d8e4SJed Brown for (j=0; j<bn; j++) { 23886719d8e4SJed Brown PetscReal rdiff; 23896719d8e4SJed Brown rdiff = PetscAbsScalar(ca[j]) / (threshold_atol + threshold_rtol*PetscAbsScalar(ba[j])); 23906719d8e4SJed Brown if (rdiff > 1) { 23916719d8e4SJed Brown ierr = PetscViewerASCIIPrintf(vstdout," (%D,%G:%G)",bj[j],PetscRealPart(ba[j]),PetscRealPart(ca[j]));CHKERRQ(ierr); 23926719d8e4SJed Brown } 23936719d8e4SJed Brown } 23946719d8e4SJed Brown ierr = PetscViewerASCIIPrintf(vstdout,"\n",i,maxentry,maxdiff,maxrdiff);CHKERRQ(ierr); 23956719d8e4SJed Brown } 23966719d8e4SJed Brown ierr = MatRestoreRow(*B,i,&bn,&bj,&ba);CHKERRQ(ierr); 23976719d8e4SJed Brown ierr = MatRestoreRow(Bfd,i,&cn,&cj,&ca);CHKERRQ(ierr); 23986719d8e4SJed Brown } 23996719d8e4SJed Brown } 24004c30e9fbSJed Brown ierr = PetscViewerDestroy(&vdraw);CHKERRQ(ierr); 24014c30e9fbSJed Brown ierr = MatDestroy(&Bfd);CHKERRQ(ierr); 24024c30e9fbSJed Brown } 24034c30e9fbSJed Brown } 24043a40ed3dSBarry Smith PetscFunctionReturn(0); 24059b94acceSBarry Smith } 24069b94acceSBarry Smith 2407bf388a1fSBarry Smith /*MC 2408bf388a1fSBarry Smith SNESJacobianFunction - function used to convey the nonlinear Jacobian of the function to be solved by SNES 2409bf388a1fSBarry Smith 2410bf388a1fSBarry Smith Synopsis: 2411bf388a1fSBarry Smith #include "petscsnes.h" 2412e5d3d808SBarry Smith $ SNESJacobianFunction(SNES snes,Vec x,Mat *Amat,Mat *Pmat,int *flag,void *ctx); 2413bf388a1fSBarry Smith 2414bf388a1fSBarry Smith + x - input vector 2415e5d3d808SBarry Smith . Amat - the matrix that defines the (approximate) Jacobian 2416e5d3d808SBarry Smith . Pmat - the matrix to be used in constructing the preconditioner, usually the same as Amat. 2417bf388a1fSBarry Smith . flag - flag indicating information about the preconditioner matrix 2418bf388a1fSBarry Smith structure (same as flag in KSPSetOperators()), one of SAME_NONZERO_PATTERN,DIFFERENT_NONZERO_PATTERN,SAME_PRECONDITIONER 2419bf388a1fSBarry Smith - ctx - [optional] user-defined Jacobian context 2420bf388a1fSBarry Smith 2421878cb397SSatish Balay Level: intermediate 2422878cb397SSatish Balay 2423bf388a1fSBarry Smith .seealso: SNESSetFunction(), SNESGetFunction(), SNESSetJacobian(), SNESGetJacobian() 2424bf388a1fSBarry Smith M*/ 2425bf388a1fSBarry Smith 24264a2ae208SSatish Balay #undef __FUNCT__ 24274a2ae208SSatish Balay #define __FUNCT__ "SNESSetJacobian" 24289b94acceSBarry Smith /*@C 24299b94acceSBarry Smith SNESSetJacobian - Sets the function to compute Jacobian as well as the 2430044dda88SLois Curfman McInnes location to store the matrix. 24319b94acceSBarry Smith 24323f9fe445SBarry Smith Logically Collective on SNES and Mat 2433c7afd0dbSLois Curfman McInnes 24349b94acceSBarry Smith Input Parameters: 2435c7afd0dbSLois Curfman McInnes + snes - the SNES context 2436e5d3d808SBarry Smith . Amat - the matrix that defines the (approximate) Jacobian 2437e5d3d808SBarry Smith . Pmat - the matrix to be used in constructing the preconditioner, usually the same as Amat. 24380298fd71SBarry Smith . SNESJacobianFunction - Jacobian evaluation routine (if NULL then SNES retains any previously set value) 2439c7afd0dbSLois Curfman McInnes - ctx - [optional] user-defined context for private data for the 24400298fd71SBarry Smith Jacobian evaluation routine (may be NULL) (if NULL then SNES retains any previously set value) 24419b94acceSBarry Smith 24429b94acceSBarry Smith Notes: 244394b7f48cSBarry Smith See KSPSetOperators() for important information about setting the flag 24442cd2dfdcSLois Curfman McInnes output parameter in the routine func(). Be sure to read this information! 2445ac21db08SLois Curfman McInnes 2446ac21db08SLois Curfman McInnes The routine func() takes Mat * as the matrix arguments rather than Mat. 24479b94acceSBarry Smith This allows the Jacobian evaluation routine to replace A and/or B with a 24489b94acceSBarry Smith completely new new matrix structure (not just different matrix elements) 24499b94acceSBarry Smith when appropriate, for instance, if the nonzero structure is changing 24509b94acceSBarry Smith throughout the global iterations. 24519b94acceSBarry Smith 2452e5d3d808SBarry Smith If the Amat matrix and Pmat matrix are different you must call MatAssemblyBegin/End() on 245316913363SBarry Smith each matrix. 245416913363SBarry Smith 24558d359177SBarry Smith If using SNESComputeJacobianDefaultColor() to assemble a Jacobian, the ctx argument 2456a8a26c1eSJed Brown must be a MatFDColoring. 2457a8a26c1eSJed Brown 2458c3cc8fd1SJed Brown Other defect-correction schemes can be used by computing a different matrix in place of the Jacobian. One common 2459c3cc8fd1SJed Brown example is to use the "Picard linearization" which only differentiates through the highest order parts of each term. 2460c3cc8fd1SJed Brown 246136851e7fSLois Curfman McInnes Level: beginner 246236851e7fSLois Curfman McInnes 24639b94acceSBarry Smith .keywords: SNES, nonlinear, set, Jacobian, matrix 24649b94acceSBarry Smith 2465e5d3d808SBarry Smith .seealso: KSPSetOperators(), SNESSetFunction(), MatMFFDComputeJacobian(), SNESComputeJacobianDefaultColor(), MatStructure, SNESJacobianFunction, SNESSetPicard() 24669b94acceSBarry Smith @*/ 2467e5d3d808SBarry Smith PetscErrorCode SNESSetJacobian(SNES snes,Mat Amat,Mat Pmat,PetscErrorCode (*SNESJacobianFunction)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void *ctx) 24689b94acceSBarry Smith { 2469dfbe8321SBarry Smith PetscErrorCode ierr; 24706cab3a1bSJed Brown DM dm; 24713a7fca6bSBarry Smith 24723a40ed3dSBarry Smith PetscFunctionBegin; 24730700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 2474e5d3d808SBarry Smith if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2); 2475e5d3d808SBarry Smith if (Pmat) PetscValidHeaderSpecific(Pmat,MAT_CLASSID,3); 2476e5d3d808SBarry Smith if (Amat) PetscCheckSameComm(snes,1,Amat,2); 2477e5d3d808SBarry Smith if (Pmat) PetscCheckSameComm(snes,1,Pmat,3); 24786cab3a1bSJed Brown ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr); 2479bf388a1fSBarry Smith ierr = DMSNESSetJacobian(dm,SNESJacobianFunction,ctx);CHKERRQ(ierr); 2480e5d3d808SBarry Smith if (Amat) { 2481e5d3d808SBarry Smith ierr = PetscObjectReference((PetscObject)Amat);CHKERRQ(ierr); 24826bf464f9SBarry Smith ierr = MatDestroy(&snes->jacobian);CHKERRQ(ierr); 2483f5af7f23SKarl Rupp 2484e5d3d808SBarry Smith snes->jacobian = Amat; 24853a7fca6bSBarry Smith } 2486e5d3d808SBarry Smith if (Pmat) { 2487e5d3d808SBarry Smith ierr = PetscObjectReference((PetscObject)Pmat);CHKERRQ(ierr); 24886bf464f9SBarry Smith ierr = MatDestroy(&snes->jacobian_pre);CHKERRQ(ierr); 2489f5af7f23SKarl Rupp 2490e5d3d808SBarry Smith snes->jacobian_pre = Pmat; 24913a7fca6bSBarry Smith } 24923a40ed3dSBarry Smith PetscFunctionReturn(0); 24939b94acceSBarry Smith } 249462fef451SLois Curfman McInnes 24954a2ae208SSatish Balay #undef __FUNCT__ 24964a2ae208SSatish Balay #define __FUNCT__ "SNESGetJacobian" 2497c2aafc4cSSatish Balay /*@C 2498b4fd4287SBarry Smith SNESGetJacobian - Returns the Jacobian matrix and optionally the user 2499b4fd4287SBarry Smith provided context for evaluating the Jacobian. 2500b4fd4287SBarry Smith 2501c7afd0dbSLois Curfman McInnes Not Collective, but Mat object will be parallel if SNES object is 2502c7afd0dbSLois Curfman McInnes 2503b4fd4287SBarry Smith Input Parameter: 2504b4fd4287SBarry Smith . snes - the nonlinear solver context 2505b4fd4287SBarry Smith 2506b4fd4287SBarry Smith Output Parameters: 2507e5d3d808SBarry Smith + Amat - location to stash (approximate) Jacobian matrix (or NULL) 2508e5d3d808SBarry Smith . Pmat - location to stash matrix used to compute the preconditioner (or NULL) 25090298fd71SBarry Smith . SNESJacobianFunction - location to put Jacobian function (or NULL) 25100298fd71SBarry Smith - ctx - location to stash Jacobian ctx (or NULL) 2511fee21e36SBarry Smith 251236851e7fSLois Curfman McInnes Level: advanced 251336851e7fSLois Curfman McInnes 2514b4fd4287SBarry Smith .seealso: SNESSetJacobian(), SNESComputeJacobian() 2515b4fd4287SBarry Smith @*/ 2516e5d3d808SBarry Smith PetscErrorCode SNESGetJacobian(SNES snes,Mat *Amat,Mat *Pmat,PetscErrorCode (**SNESJacobianFunction)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void **ctx) 2517b4fd4287SBarry Smith { 25186cab3a1bSJed Brown PetscErrorCode ierr; 25196cab3a1bSJed Brown DM dm; 2520942e3340SBarry Smith DMSNES sdm; 25216cab3a1bSJed Brown 25223a40ed3dSBarry Smith PetscFunctionBegin; 25230700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 2524e5d3d808SBarry Smith if (Amat) *Amat = snes->jacobian; 2525e5d3d808SBarry Smith if (Pmat) *Pmat = snes->jacobian_pre; 25266cab3a1bSJed Brown ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr); 2527942e3340SBarry Smith ierr = DMGetDMSNES(dm,&sdm);CHKERRQ(ierr); 2528bf388a1fSBarry Smith if (SNESJacobianFunction) *SNESJacobianFunction = sdm->ops->computejacobian; 25296cab3a1bSJed Brown if (ctx) *ctx = sdm->jacobianctx; 25303a40ed3dSBarry Smith PetscFunctionReturn(0); 2531b4fd4287SBarry Smith } 2532b4fd4287SBarry Smith 25334a2ae208SSatish Balay #undef __FUNCT__ 25344a2ae208SSatish Balay #define __FUNCT__ "SNESSetUp" 25359b94acceSBarry Smith /*@ 25369b94acceSBarry Smith SNESSetUp - Sets up the internal data structures for the later use 2537272ac6f2SLois Curfman McInnes of a nonlinear solver. 25389b94acceSBarry Smith 2539fee21e36SBarry Smith Collective on SNES 2540fee21e36SBarry Smith 2541c7afd0dbSLois Curfman McInnes Input Parameters: 254270e92668SMatthew Knepley . snes - the SNES context 2543c7afd0dbSLois Curfman McInnes 2544272ac6f2SLois Curfman McInnes Notes: 2545272ac6f2SLois Curfman McInnes For basic use of the SNES solvers the user need not explicitly call 2546272ac6f2SLois Curfman McInnes SNESSetUp(), since these actions will automatically occur during 2547272ac6f2SLois Curfman McInnes the call to SNESSolve(). However, if one wishes to control this 2548272ac6f2SLois Curfman McInnes phase separately, SNESSetUp() should be called after SNESCreate() 2549272ac6f2SLois Curfman McInnes and optional routines of the form SNESSetXXX(), but before SNESSolve(). 2550272ac6f2SLois Curfman McInnes 255136851e7fSLois Curfman McInnes Level: advanced 255236851e7fSLois Curfman McInnes 25539b94acceSBarry Smith .keywords: SNES, nonlinear, setup 25549b94acceSBarry Smith 25559b94acceSBarry Smith .seealso: SNESCreate(), SNESSolve(), SNESDestroy() 25569b94acceSBarry Smith @*/ 25577087cfbeSBarry Smith PetscErrorCode SNESSetUp(SNES snes) 25589b94acceSBarry Smith { 2559dfbe8321SBarry Smith PetscErrorCode ierr; 25606cab3a1bSJed Brown DM dm; 2561942e3340SBarry Smith DMSNES sdm; 2562c35f09e5SBarry Smith SNESLineSearch linesearch, pclinesearch; 25636e2a1849SPeter Brune void *lsprectx,*lspostctx; 25646b2b7091SBarry Smith PetscErrorCode (*precheck)(SNESLineSearch,Vec,Vec,PetscBool*,void*); 25656b2b7091SBarry Smith PetscErrorCode (*postcheck)(SNESLineSearch,Vec,Vec,Vec,PetscBool*,PetscBool*,void*); 25666e2a1849SPeter Brune PetscErrorCode (*func)(SNES,Vec,Vec,void*); 25676e2a1849SPeter Brune Vec f,fpc; 25686e2a1849SPeter Brune void *funcctx; 25696e2a1849SPeter Brune PetscErrorCode (*jac)(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 25701eb13d49SPeter Brune void *jacctx,*appctx; 25713a40ed3dSBarry Smith 25723a40ed3dSBarry Smith PetscFunctionBegin; 25730700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 25744dc4c822SBarry Smith if (snes->setupcalled) PetscFunctionReturn(0); 25759b94acceSBarry Smith 25767adad957SLisandro Dalcin if (!((PetscObject)snes)->type_name) { 257704d7464bSBarry Smith ierr = SNESSetType(snes,SNESNEWTONLS);CHKERRQ(ierr); 257885385478SLisandro Dalcin } 257985385478SLisandro Dalcin 25800298fd71SBarry Smith ierr = SNESGetFunction(snes,&snes->vec_func,NULL,NULL);CHKERRQ(ierr); 258117186662SBarry Smith if (snes->vec_func == snes->vec_sol) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_IDN,"Solution vector cannot be function vector"); 258258c9b817SLisandro Dalcin if (snes->vec_rhs == snes->vec_sol) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_IDN,"Solution vector cannot be right hand side vector"); 258358c9b817SLisandro Dalcin 258458c9b817SLisandro Dalcin if (!snes->vec_sol_update /* && snes->vec_sol */) { 258558c9b817SLisandro Dalcin ierr = VecDuplicate(snes->vec_sol,&snes->vec_sol_update);CHKERRQ(ierr); 25863bb1ff40SBarry Smith ierr = PetscLogObjectParent((PetscObject)snes,(PetscObject)snes->vec_sol_update);CHKERRQ(ierr); 258758c9b817SLisandro Dalcin } 258858c9b817SLisandro Dalcin 25896cab3a1bSJed Brown ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr); 2590d8f46077SPeter Brune ierr = DMShellSetGlobalVector(snes->dm,snes->vec_sol);CHKERRQ(ierr); 2591942e3340SBarry Smith ierr = DMGetDMSNES(dm,&sdm);CHKERRQ(ierr); 2592ce94432eSBarry Smith if (!sdm->ops->computefunction) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_WRONGSTATE,"Function never provided to SNES object"); 259322c6f798SBarry Smith if (!sdm->ops->computejacobian) { 25948d359177SBarry Smith ierr = DMSNESSetJacobian(dm,SNESComputeJacobianDefaultColor,NULL);CHKERRQ(ierr); 259519f7a02aSBarry Smith } 25966cab3a1bSJed Brown if (!snes->vec_func) { 25976cab3a1bSJed Brown ierr = DMCreateGlobalVector(dm,&snes->vec_func);CHKERRQ(ierr); 2598214df951SJed Brown } 2599efd51863SBarry Smith 260022d28d08SBarry Smith if (!snes->ksp) { 260122d28d08SBarry Smith ierr = SNESGetKSP(snes, &snes->ksp);CHKERRQ(ierr); 260222d28d08SBarry Smith } 2603b710008aSBarry Smith 260422d28d08SBarry Smith if (!snes->linesearch) { 26057601faf0SJed Brown ierr = SNESGetLineSearch(snes, &snes->linesearch);CHKERRQ(ierr); 260622d28d08SBarry Smith } 2607ed07d7d7SPeter Brune ierr = SNESLineSearchSetFunction(snes->linesearch,SNESComputeFunction);CHKERRQ(ierr); 26089e764e56SPeter Brune 2609172a4300SPeter Brune if (snes->pc && (snes->pcside == PC_LEFT)) { 2610172a4300SPeter Brune snes->mf = PETSC_TRUE; 2611172a4300SPeter Brune snes->mf_operator = PETSC_FALSE; 2612172a4300SPeter Brune } 2613d8f46077SPeter Brune 261428a52e04SBarry Smith if (snes->mf) { 261528a52e04SBarry Smith ierr = SNESSetUpMatrixFree_Private(snes, snes->mf_operator, snes->mf_version);CHKERRQ(ierr); 261628a52e04SBarry Smith } 2617d8f46077SPeter Brune 2618d25893d9SBarry Smith if (snes->ops->usercompute && !snes->user) { 2619d25893d9SBarry Smith ierr = (*snes->ops->usercompute)(snes,(void**)&snes->user);CHKERRQ(ierr); 2620d25893d9SBarry Smith } 2621d25893d9SBarry Smith 26226e2a1849SPeter Brune if (snes->pc) { 26236e2a1849SPeter Brune /* copy the DM over */ 26246e2a1849SPeter Brune ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr); 26256e2a1849SPeter Brune ierr = SNESSetDM(snes->pc,dm);CHKERRQ(ierr); 26266e2a1849SPeter Brune 26276e2a1849SPeter Brune ierr = SNESGetFunction(snes,&f,&func,&funcctx);CHKERRQ(ierr); 26286e2a1849SPeter Brune ierr = VecDuplicate(f,&fpc);CHKERRQ(ierr); 26296e2a1849SPeter Brune ierr = SNESSetFunction(snes->pc,fpc,func,funcctx);CHKERRQ(ierr); 2630902f982fSPeter Brune ierr = SNESGetJacobian(snes,NULL,NULL,&jac,&jacctx);CHKERRQ(ierr); 2631902f982fSPeter Brune ierr = SNESSetJacobian(snes->pc,NULL,NULL,jac,jacctx);CHKERRQ(ierr); 26321eb13d49SPeter Brune ierr = SNESGetApplicationContext(snes,&appctx);CHKERRQ(ierr); 26331eb13d49SPeter Brune ierr = SNESSetApplicationContext(snes->pc,appctx);CHKERRQ(ierr); 26346e2a1849SPeter Brune ierr = VecDestroy(&fpc);CHKERRQ(ierr); 26356e2a1849SPeter Brune 26366e2a1849SPeter Brune /* copy the function pointers over */ 26376e2a1849SPeter Brune ierr = PetscObjectCopyFortranFunctionPointers((PetscObject)snes,(PetscObject)snes->pc);CHKERRQ(ierr); 26386e2a1849SPeter Brune 26396e2a1849SPeter Brune /* default to 1 iteration */ 2640140836e4SPeter Brune ierr = SNESSetTolerances(snes->pc,0.0,0.0,0.0,1,snes->pc->max_funcs);CHKERRQ(ierr); 2641a9936a0cSPeter Brune if (snes->pcside==PC_RIGHT) { 2642365a6726SPeter Brune ierr = SNESSetNormSchedule(snes->pc,SNES_NORM_FINAL_ONLY);CHKERRQ(ierr); 2643a9936a0cSPeter Brune } else { 2644365a6726SPeter Brune ierr = SNESSetNormSchedule(snes->pc,SNES_NORM_NONE);CHKERRQ(ierr); 2645a9936a0cSPeter Brune } 26466e2a1849SPeter Brune ierr = SNESSetFromOptions(snes->pc);CHKERRQ(ierr); 26476e2a1849SPeter Brune 26486e2a1849SPeter Brune /* copy the line search context over */ 26497601faf0SJed Brown ierr = SNESGetLineSearch(snes,&linesearch);CHKERRQ(ierr); 26507601faf0SJed Brown ierr = SNESGetLineSearch(snes->pc,&pclinesearch);CHKERRQ(ierr); 26516b2b7091SBarry Smith ierr = SNESLineSearchGetPreCheck(linesearch,&precheck,&lsprectx);CHKERRQ(ierr); 26526b2b7091SBarry Smith ierr = SNESLineSearchGetPostCheck(linesearch,&postcheck,&lspostctx);CHKERRQ(ierr); 26536b2b7091SBarry Smith ierr = SNESLineSearchSetPreCheck(pclinesearch,precheck,lsprectx);CHKERRQ(ierr); 26546b2b7091SBarry Smith ierr = SNESLineSearchSetPostCheck(pclinesearch,postcheck,lspostctx);CHKERRQ(ierr); 26556e2a1849SPeter Brune ierr = PetscObjectCopyFortranFunctionPointers((PetscObject)linesearch, (PetscObject)pclinesearch);CHKERRQ(ierr); 26566e2a1849SPeter Brune } 26576e2a1849SPeter Brune 265837ec4e1aSPeter Brune snes->jac_iter = 0; 265937ec4e1aSPeter Brune snes->pre_iter = 0; 266037ec4e1aSPeter Brune 2661410397dcSLisandro Dalcin if (snes->ops->setup) { 2662410397dcSLisandro Dalcin ierr = (*snes->ops->setup)(snes);CHKERRQ(ierr); 2663410397dcSLisandro Dalcin } 266458c9b817SLisandro Dalcin 26656c67d002SPeter Brune if (snes->pc && (snes->pcside == PC_LEFT)) { 26666c67d002SPeter Brune if (snes->functype == SNES_FUNCTION_PRECONDITIONED) { 266755d4788fSPeter Brune ierr = SNESGetLineSearch(snes,&linesearch);CHKERRQ(ierr); 266855d4788fSPeter Brune ierr = SNESLineSearchSetFunction(linesearch,SNESComputeFunctionDefaultPC);CHKERRQ(ierr); 26696c67d002SPeter Brune } 26706c67d002SPeter Brune } 26716c67d002SPeter Brune 26727aaed0d8SBarry Smith snes->setupcalled = PETSC_TRUE; 26733a40ed3dSBarry Smith PetscFunctionReturn(0); 26749b94acceSBarry Smith } 26759b94acceSBarry Smith 26764a2ae208SSatish Balay #undef __FUNCT__ 267737596af1SLisandro Dalcin #define __FUNCT__ "SNESReset" 267837596af1SLisandro Dalcin /*@ 267937596af1SLisandro Dalcin SNESReset - Resets a SNES context to the snessetupcalled = 0 state and removes any allocated Vecs and Mats 268037596af1SLisandro Dalcin 268137596af1SLisandro Dalcin Collective on SNES 268237596af1SLisandro Dalcin 268337596af1SLisandro Dalcin Input Parameter: 268437596af1SLisandro Dalcin . snes - iterative context obtained from SNESCreate() 268537596af1SLisandro Dalcin 2686d25893d9SBarry Smith Level: intermediate 2687d25893d9SBarry Smith 2688d25893d9SBarry Smith Notes: Also calls the application context destroy routine set with SNESSetComputeApplicationContext() 268937596af1SLisandro Dalcin 269037596af1SLisandro Dalcin .keywords: SNES, destroy 269137596af1SLisandro Dalcin 269237596af1SLisandro Dalcin .seealso: SNESCreate(), SNESSetUp(), SNESSolve() 269337596af1SLisandro Dalcin @*/ 269437596af1SLisandro Dalcin PetscErrorCode SNESReset(SNES snes) 269537596af1SLisandro Dalcin { 269637596af1SLisandro Dalcin PetscErrorCode ierr; 269737596af1SLisandro Dalcin 269837596af1SLisandro Dalcin PetscFunctionBegin; 269937596af1SLisandro Dalcin PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 2700d25893d9SBarry Smith if (snes->ops->userdestroy && snes->user) { 2701d25893d9SBarry Smith ierr = (*snes->ops->userdestroy)((void**)&snes->user);CHKERRQ(ierr); 27020298fd71SBarry Smith snes->user = NULL; 2703d25893d9SBarry Smith } 27048a23116dSBarry Smith if (snes->pc) { 27058a23116dSBarry Smith ierr = SNESReset(snes->pc);CHKERRQ(ierr); 27068a23116dSBarry Smith } 27078a23116dSBarry Smith 270837596af1SLisandro Dalcin if (snes->ops->reset) { 270937596af1SLisandro Dalcin ierr = (*snes->ops->reset)(snes);CHKERRQ(ierr); 271037596af1SLisandro Dalcin } 27119e764e56SPeter Brune if (snes->ksp) { 27129e764e56SPeter Brune ierr = KSPReset(snes->ksp);CHKERRQ(ierr); 27139e764e56SPeter Brune } 27149e764e56SPeter Brune 27159e764e56SPeter Brune if (snes->linesearch) { 2716f1c6b773SPeter Brune ierr = SNESLineSearchReset(snes->linesearch);CHKERRQ(ierr); 27179e764e56SPeter Brune } 27189e764e56SPeter Brune 27196bf464f9SBarry Smith ierr = VecDestroy(&snes->vec_rhs);CHKERRQ(ierr); 27206bf464f9SBarry Smith ierr = VecDestroy(&snes->vec_sol);CHKERRQ(ierr); 27216bf464f9SBarry Smith ierr = VecDestroy(&snes->vec_sol_update);CHKERRQ(ierr); 27226bf464f9SBarry Smith ierr = VecDestroy(&snes->vec_func);CHKERRQ(ierr); 27236bf464f9SBarry Smith ierr = MatDestroy(&snes->jacobian);CHKERRQ(ierr); 27246bf464f9SBarry Smith ierr = MatDestroy(&snes->jacobian_pre);CHKERRQ(ierr); 2725c41d97abSJed Brown ierr = VecDestroyVecs(snes->nwork,&snes->work);CHKERRQ(ierr); 2726c41d97abSJed Brown ierr = VecDestroyVecs(snes->nvwork,&snes->vwork);CHKERRQ(ierr); 2727f5af7f23SKarl Rupp 272837596af1SLisandro Dalcin snes->nwork = snes->nvwork = 0; 272937596af1SLisandro Dalcin snes->setupcalled = PETSC_FALSE; 273037596af1SLisandro Dalcin PetscFunctionReturn(0); 273137596af1SLisandro Dalcin } 273237596af1SLisandro Dalcin 273337596af1SLisandro Dalcin #undef __FUNCT__ 27344a2ae208SSatish Balay #define __FUNCT__ "SNESDestroy" 273552baeb72SSatish Balay /*@ 27369b94acceSBarry Smith SNESDestroy - Destroys the nonlinear solver context that was created 27379b94acceSBarry Smith with SNESCreate(). 27389b94acceSBarry Smith 2739c7afd0dbSLois Curfman McInnes Collective on SNES 2740c7afd0dbSLois Curfman McInnes 27419b94acceSBarry Smith Input Parameter: 27429b94acceSBarry Smith . snes - the SNES context 27439b94acceSBarry Smith 274436851e7fSLois Curfman McInnes Level: beginner 274536851e7fSLois Curfman McInnes 27469b94acceSBarry Smith .keywords: SNES, nonlinear, destroy 27479b94acceSBarry Smith 274863a78c88SLois Curfman McInnes .seealso: SNESCreate(), SNESSolve() 27499b94acceSBarry Smith @*/ 27506bf464f9SBarry Smith PetscErrorCode SNESDestroy(SNES *snes) 27519b94acceSBarry Smith { 27526849ba73SBarry Smith PetscErrorCode ierr; 27533a40ed3dSBarry Smith 27543a40ed3dSBarry Smith PetscFunctionBegin; 27556bf464f9SBarry Smith if (!*snes) PetscFunctionReturn(0); 27566bf464f9SBarry Smith PetscValidHeaderSpecific((*snes),SNES_CLASSID,1); 27576bf464f9SBarry Smith if (--((PetscObject)(*snes))->refct > 0) {*snes = 0; PetscFunctionReturn(0);} 2758d4bb536fSBarry Smith 27596bf464f9SBarry Smith ierr = SNESReset((*snes));CHKERRQ(ierr); 27608a23116dSBarry Smith ierr = SNESDestroy(&(*snes)->pc);CHKERRQ(ierr); 27616b8b9a38SLisandro Dalcin 2762be0abb6dSBarry Smith /* if memory was published with AMS then destroy it */ 2763f05ece33SBarry Smith ierr = PetscObjectAMSViewOff((PetscObject)*snes);CHKERRQ(ierr); 27646bf464f9SBarry Smith if ((*snes)->ops->destroy) {ierr = (*((*snes))->ops->destroy)((*snes));CHKERRQ(ierr);} 27656d4c513bSLisandro Dalcin 27666bf464f9SBarry Smith ierr = DMDestroy(&(*snes)->dm);CHKERRQ(ierr); 27676bf464f9SBarry Smith ierr = KSPDestroy(&(*snes)->ksp);CHKERRQ(ierr); 2768f1c6b773SPeter Brune ierr = SNESLineSearchDestroy(&(*snes)->linesearch);CHKERRQ(ierr); 27696b8b9a38SLisandro Dalcin 27706bf464f9SBarry Smith ierr = PetscFree((*snes)->kspconvctx);CHKERRQ(ierr); 27716bf464f9SBarry Smith if ((*snes)->ops->convergeddestroy) { 27726bf464f9SBarry Smith ierr = (*(*snes)->ops->convergeddestroy)((*snes)->cnvP);CHKERRQ(ierr); 27736b8b9a38SLisandro Dalcin } 27746bf464f9SBarry Smith if ((*snes)->conv_malloc) { 27756bf464f9SBarry Smith ierr = PetscFree((*snes)->conv_hist);CHKERRQ(ierr); 27766bf464f9SBarry Smith ierr = PetscFree((*snes)->conv_hist_its);CHKERRQ(ierr); 277758c9b817SLisandro Dalcin } 27786bf464f9SBarry Smith ierr = SNESMonitorCancel((*snes));CHKERRQ(ierr); 2779a79aaaedSSatish Balay ierr = PetscHeaderDestroy(snes);CHKERRQ(ierr); 27803a40ed3dSBarry Smith PetscFunctionReturn(0); 27819b94acceSBarry Smith } 27829b94acceSBarry Smith 27839b94acceSBarry Smith /* ----------- Routines to set solver parameters ---------- */ 27849b94acceSBarry Smith 27854a2ae208SSatish Balay #undef __FUNCT__ 2786a8054027SBarry Smith #define __FUNCT__ "SNESSetLagPreconditioner" 2787a8054027SBarry Smith /*@ 2788a8054027SBarry Smith SNESSetLagPreconditioner - Determines when the preconditioner is rebuilt in the nonlinear solve. 2789a8054027SBarry Smith 27903f9fe445SBarry Smith Logically Collective on SNES 2791a8054027SBarry Smith 2792a8054027SBarry Smith Input Parameters: 2793a8054027SBarry Smith + snes - the SNES context 2794a8054027SBarry 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 27953b4f5425SBarry Smith the Jacobian is built etc. -2 indicates rebuild preconditioner at next chance but then never rebuild after that 2796a8054027SBarry Smith 2797a8054027SBarry Smith Options Database Keys: 2798a8054027SBarry Smith . -snes_lag_preconditioner <lag> 2799a8054027SBarry Smith 2800a8054027SBarry Smith Notes: 2801a8054027SBarry Smith The default is 1 2802a8054027SBarry Smith The preconditioner is ALWAYS built in the first iteration of a nonlinear solve unless lag is -1 2803a8054027SBarry Smith If -1 is used before the very first nonlinear solve the preconditioner is still built because there is no previous preconditioner to use 2804a8054027SBarry Smith 2805a8054027SBarry Smith Level: intermediate 2806a8054027SBarry Smith 2807a8054027SBarry Smith .keywords: SNES, nonlinear, set, convergence, tolerances 2808a8054027SBarry Smith 2809e35cf81dSBarry Smith .seealso: SNESSetTrustRegionTolerance(), SNESGetLagPreconditioner(), SNESSetLagJacobian(), SNESGetLagJacobian() 2810a8054027SBarry Smith 2811a8054027SBarry Smith @*/ 28127087cfbeSBarry Smith PetscErrorCode SNESSetLagPreconditioner(SNES snes,PetscInt lag) 2813a8054027SBarry Smith { 2814a8054027SBarry Smith PetscFunctionBegin; 28150700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 2816e32f2f54SBarry Smith if (lag < -2) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Lag must be -2, -1, 1 or greater"); 2817e32f2f54SBarry Smith if (!lag) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Lag cannot be 0"); 2818c5eb9154SBarry Smith PetscValidLogicalCollectiveInt(snes,lag,2); 2819a8054027SBarry Smith snes->lagpreconditioner = lag; 2820a8054027SBarry Smith PetscFunctionReturn(0); 2821a8054027SBarry Smith } 2822a8054027SBarry Smith 2823a8054027SBarry Smith #undef __FUNCT__ 2824efd51863SBarry Smith #define __FUNCT__ "SNESSetGridSequence" 2825efd51863SBarry Smith /*@ 2826efd51863SBarry Smith SNESSetGridSequence - sets the number of steps of grid sequencing that SNES does 2827efd51863SBarry Smith 2828efd51863SBarry Smith Logically Collective on SNES 2829efd51863SBarry Smith 2830efd51863SBarry Smith Input Parameters: 2831efd51863SBarry Smith + snes - the SNES context 2832efd51863SBarry Smith - steps - the number of refinements to do, defaults to 0 2833efd51863SBarry Smith 2834efd51863SBarry Smith Options Database Keys: 2835efd51863SBarry Smith . -snes_grid_sequence <steps> 2836efd51863SBarry Smith 2837efd51863SBarry Smith Level: intermediate 2838efd51863SBarry Smith 2839c0df2a02SJed Brown Notes: 2840c0df2a02SJed Brown Use SNESGetSolution() to extract the fine grid solution after grid sequencing. 2841c0df2a02SJed Brown 2842efd51863SBarry Smith .keywords: SNES, nonlinear, set, convergence, tolerances 2843efd51863SBarry Smith 2844efd51863SBarry Smith .seealso: SNESSetTrustRegionTolerance(), SNESGetLagPreconditioner(), SNESSetLagJacobian(), SNESGetLagJacobian() 2845efd51863SBarry Smith 2846efd51863SBarry Smith @*/ 2847efd51863SBarry Smith PetscErrorCode SNESSetGridSequence(SNES snes,PetscInt steps) 2848efd51863SBarry Smith { 2849efd51863SBarry Smith PetscFunctionBegin; 2850efd51863SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 2851efd51863SBarry Smith PetscValidLogicalCollectiveInt(snes,steps,2); 2852efd51863SBarry Smith snes->gridsequence = steps; 2853efd51863SBarry Smith PetscFunctionReturn(0); 2854efd51863SBarry Smith } 2855efd51863SBarry Smith 2856efd51863SBarry Smith #undef __FUNCT__ 2857a8054027SBarry Smith #define __FUNCT__ "SNESGetLagPreconditioner" 2858a8054027SBarry Smith /*@ 2859a8054027SBarry Smith SNESGetLagPreconditioner - Indicates how often the preconditioner is rebuilt 2860a8054027SBarry Smith 28613f9fe445SBarry Smith Not Collective 2862a8054027SBarry Smith 2863a8054027SBarry Smith Input Parameter: 2864a8054027SBarry Smith . snes - the SNES context 2865a8054027SBarry Smith 2866a8054027SBarry Smith Output Parameter: 2867a8054027SBarry 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 28683b4f5425SBarry Smith the Jacobian is built etc. -2 indicates rebuild preconditioner at next chance but then never rebuild after that 2869a8054027SBarry Smith 2870a8054027SBarry Smith Options Database Keys: 2871a8054027SBarry Smith . -snes_lag_preconditioner <lag> 2872a8054027SBarry Smith 2873a8054027SBarry Smith Notes: 2874a8054027SBarry Smith The default is 1 2875a8054027SBarry Smith The preconditioner is ALWAYS built in the first iteration of a nonlinear solve unless lag is -1 2876a8054027SBarry Smith 2877a8054027SBarry Smith Level: intermediate 2878a8054027SBarry Smith 2879a8054027SBarry Smith .keywords: SNES, nonlinear, set, convergence, tolerances 2880a8054027SBarry Smith 2881a8054027SBarry Smith .seealso: SNESSetTrustRegionTolerance(), SNESSetLagPreconditioner() 2882a8054027SBarry Smith 2883a8054027SBarry Smith @*/ 28847087cfbeSBarry Smith PetscErrorCode SNESGetLagPreconditioner(SNES snes,PetscInt *lag) 2885a8054027SBarry Smith { 2886a8054027SBarry Smith PetscFunctionBegin; 28870700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 2888a8054027SBarry Smith *lag = snes->lagpreconditioner; 2889a8054027SBarry Smith PetscFunctionReturn(0); 2890a8054027SBarry Smith } 2891a8054027SBarry Smith 2892a8054027SBarry Smith #undef __FUNCT__ 2893e35cf81dSBarry Smith #define __FUNCT__ "SNESSetLagJacobian" 2894e35cf81dSBarry Smith /*@ 2895e35cf81dSBarry Smith SNESSetLagJacobian - Determines when the Jacobian is rebuilt in the nonlinear solve. See SNESSetLagPreconditioner() for determining how 2896e35cf81dSBarry Smith often the preconditioner is rebuilt. 2897e35cf81dSBarry Smith 28983f9fe445SBarry Smith Logically Collective on SNES 2899e35cf81dSBarry Smith 2900e35cf81dSBarry Smith Input Parameters: 2901e35cf81dSBarry Smith + snes - the SNES context 2902e35cf81dSBarry 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 2903fe3ffe1eSBarry Smith the Jacobian is built etc. -2 means rebuild at next chance but then never again 2904e35cf81dSBarry Smith 2905e35cf81dSBarry Smith Options Database Keys: 2906e35cf81dSBarry Smith . -snes_lag_jacobian <lag> 2907e35cf81dSBarry Smith 2908e35cf81dSBarry Smith Notes: 2909e35cf81dSBarry Smith The default is 1 2910e35cf81dSBarry Smith The Jacobian is ALWAYS built in the first iteration of a nonlinear solve unless lag is -1 2911fe3ffe1eSBarry 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 2912fe3ffe1eSBarry Smith at the next Newton step but never again (unless it is reset to another value) 2913e35cf81dSBarry Smith 2914e35cf81dSBarry Smith Level: intermediate 2915e35cf81dSBarry Smith 2916e35cf81dSBarry Smith .keywords: SNES, nonlinear, set, convergence, tolerances 2917e35cf81dSBarry Smith 2918e35cf81dSBarry Smith .seealso: SNESSetTrustRegionTolerance(), SNESGetLagPreconditioner(), SNESSetLagPreconditioner(), SNESGetLagJacobian() 2919e35cf81dSBarry Smith 2920e35cf81dSBarry Smith @*/ 29217087cfbeSBarry Smith PetscErrorCode SNESSetLagJacobian(SNES snes,PetscInt lag) 2922e35cf81dSBarry Smith { 2923e35cf81dSBarry Smith PetscFunctionBegin; 29240700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 2925e32f2f54SBarry Smith if (lag < -2) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Lag must be -2, -1, 1 or greater"); 2926e32f2f54SBarry Smith if (!lag) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Lag cannot be 0"); 2927c5eb9154SBarry Smith PetscValidLogicalCollectiveInt(snes,lag,2); 2928e35cf81dSBarry Smith snes->lagjacobian = lag; 2929e35cf81dSBarry Smith PetscFunctionReturn(0); 2930e35cf81dSBarry Smith } 2931e35cf81dSBarry Smith 2932e35cf81dSBarry Smith #undef __FUNCT__ 2933e35cf81dSBarry Smith #define __FUNCT__ "SNESGetLagJacobian" 2934e35cf81dSBarry Smith /*@ 2935e35cf81dSBarry Smith SNESGetLagJacobian - Indicates how often the Jacobian is rebuilt. See SNESGetLagPreconditioner() to determine when the preconditioner is rebuilt 2936e35cf81dSBarry Smith 29373f9fe445SBarry Smith Not Collective 2938e35cf81dSBarry Smith 2939e35cf81dSBarry Smith Input Parameter: 2940e35cf81dSBarry Smith . snes - the SNES context 2941e35cf81dSBarry Smith 2942e35cf81dSBarry Smith Output Parameter: 2943e35cf81dSBarry 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 2944e35cf81dSBarry Smith the Jacobian is built etc. 2945e35cf81dSBarry Smith 2946e35cf81dSBarry Smith Options Database Keys: 2947e35cf81dSBarry Smith . -snes_lag_jacobian <lag> 2948e35cf81dSBarry Smith 2949e35cf81dSBarry Smith Notes: 2950e35cf81dSBarry Smith The default is 1 2951e35cf81dSBarry Smith The jacobian is ALWAYS built in the first iteration of a nonlinear solve unless lag is -1 2952e35cf81dSBarry Smith 2953e35cf81dSBarry Smith Level: intermediate 2954e35cf81dSBarry Smith 2955e35cf81dSBarry Smith .keywords: SNES, nonlinear, set, convergence, tolerances 2956e35cf81dSBarry Smith 2957e35cf81dSBarry Smith .seealso: SNESSetTrustRegionTolerance(), SNESSetLagJacobian(), SNESSetLagPreconditioner(), SNESGetLagPreconditioner() 2958e35cf81dSBarry Smith 2959e35cf81dSBarry Smith @*/ 29607087cfbeSBarry Smith PetscErrorCode SNESGetLagJacobian(SNES snes,PetscInt *lag) 2961e35cf81dSBarry Smith { 2962e35cf81dSBarry Smith PetscFunctionBegin; 29630700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 2964e35cf81dSBarry Smith *lag = snes->lagjacobian; 2965e35cf81dSBarry Smith PetscFunctionReturn(0); 2966e35cf81dSBarry Smith } 2967e35cf81dSBarry Smith 2968e35cf81dSBarry Smith #undef __FUNCT__ 296937ec4e1aSPeter Brune #define __FUNCT__ "SNESSetLagJacobianPersists" 297037ec4e1aSPeter Brune /*@ 297137ec4e1aSPeter Brune SNESSetLagJacobianPersists - Set whether or not the Jacobian lagging persists through multiple solves 297237ec4e1aSPeter Brune 297337ec4e1aSPeter Brune Logically collective on SNES 297437ec4e1aSPeter Brune 297537ec4e1aSPeter Brune Input Parameter: 297637ec4e1aSPeter Brune + snes - the SNES context 29779d7e2deaSPeter Brune - flg - jacobian lagging persists if true 297837ec4e1aSPeter Brune 297937ec4e1aSPeter Brune Options Database Keys: 298037ec4e1aSPeter Brune . -snes_lag_jacobian_persists <flg> 298137ec4e1aSPeter Brune 298237ec4e1aSPeter Brune Notes: This is useful both for nonlinear preconditioning, where it's appropriate to have the Jacobian be stale by 298337ec4e1aSPeter Brune several solves, and for implicit time-stepping, where Jacobian lagging in the inner nonlinear solve over several 298437ec4e1aSPeter Brune timesteps may present huge efficiency gains. 298537ec4e1aSPeter Brune 298637ec4e1aSPeter Brune Level: developer 298737ec4e1aSPeter Brune 298837ec4e1aSPeter Brune .keywords: SNES, nonlinear, lag, NPC 298937ec4e1aSPeter Brune 299037ec4e1aSPeter Brune .seealso: SNESSetLagPreconditionerPersists(), SNESSetLagJacobian(), SNESGetLagJacobian(), SNESGetPC() 299137ec4e1aSPeter Brune 299237ec4e1aSPeter Brune @*/ 299337ec4e1aSPeter Brune PetscErrorCode SNESSetLagJacobianPersists(SNES snes,PetscBool flg) 299437ec4e1aSPeter Brune { 299537ec4e1aSPeter Brune PetscFunctionBegin; 299637ec4e1aSPeter Brune PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 299737ec4e1aSPeter Brune PetscValidLogicalCollectiveBool(snes,flg,2); 299837ec4e1aSPeter Brune snes->lagjac_persist = flg; 299937ec4e1aSPeter Brune PetscFunctionReturn(0); 300037ec4e1aSPeter Brune } 300137ec4e1aSPeter Brune 300237ec4e1aSPeter Brune #undef __FUNCT__ 300337ec4e1aSPeter Brune #define __FUNCT__ "SNESSetLagPreconditionerPersists" 300437ec4e1aSPeter Brune /*@ 300537ec4e1aSPeter Brune SNESSetLagPreconditionerPersists - Set whether or not the preconditioner lagging persists through multiple solves 300637ec4e1aSPeter Brune 300737ec4e1aSPeter Brune Logically Collective on SNES 300837ec4e1aSPeter Brune 300937ec4e1aSPeter Brune Input Parameter: 301037ec4e1aSPeter Brune + snes - the SNES context 30119d7e2deaSPeter Brune - flg - preconditioner lagging persists if true 301237ec4e1aSPeter Brune 301337ec4e1aSPeter Brune Options Database Keys: 301437ec4e1aSPeter Brune . -snes_lag_jacobian_persists <flg> 301537ec4e1aSPeter Brune 301637ec4e1aSPeter Brune Notes: This is useful both for nonlinear preconditioning, where it's appropriate to have the preconditioner be stale 301737ec4e1aSPeter Brune by several solves, and for implicit time-stepping, where preconditioner lagging in the inner nonlinear solve over 301837ec4e1aSPeter Brune several timesteps may present huge efficiency gains. 301937ec4e1aSPeter Brune 302037ec4e1aSPeter Brune Level: developer 302137ec4e1aSPeter Brune 302237ec4e1aSPeter Brune .keywords: SNES, nonlinear, lag, NPC 302337ec4e1aSPeter Brune 302437ec4e1aSPeter Brune .seealso: SNESSetLagJacobianPersists(), SNESSetLagJacobian(), SNESGetLagJacobian(), SNESGetPC() 302537ec4e1aSPeter Brune 302637ec4e1aSPeter Brune @*/ 302737ec4e1aSPeter Brune PetscErrorCode SNESSetLagPreconditionerPersists(SNES snes,PetscBool flg) 302837ec4e1aSPeter Brune { 302937ec4e1aSPeter Brune PetscFunctionBegin; 303037ec4e1aSPeter Brune PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 303137ec4e1aSPeter Brune PetscValidLogicalCollectiveBool(snes,flg,2); 303237ec4e1aSPeter Brune snes->lagpre_persist = flg; 303337ec4e1aSPeter Brune PetscFunctionReturn(0); 303437ec4e1aSPeter Brune } 303537ec4e1aSPeter Brune 303637ec4e1aSPeter Brune #undef __FUNCT__ 30374a2ae208SSatish Balay #define __FUNCT__ "SNESSetTolerances" 30389b94acceSBarry Smith /*@ 3039d7a720efSLois Curfman McInnes SNESSetTolerances - Sets various parameters used in convergence tests. 30409b94acceSBarry Smith 30413f9fe445SBarry Smith Logically Collective on SNES 3042c7afd0dbSLois Curfman McInnes 30439b94acceSBarry Smith Input Parameters: 3044c7afd0dbSLois Curfman McInnes + snes - the SNES context 304570441072SBarry Smith . abstol - absolute convergence tolerance 304633174efeSLois Curfman McInnes . rtol - relative convergence tolerance 30475358d0d4SBarry Smith . stol - convergence tolerance in terms of the norm of the change in the solution between steps, || delta x || < stol*|| x || 304833174efeSLois Curfman McInnes . maxit - maximum number of iterations 3049c7afd0dbSLois Curfman McInnes - maxf - maximum number of function evaluations 3050fee21e36SBarry Smith 305133174efeSLois Curfman McInnes Options Database Keys: 305270441072SBarry Smith + -snes_atol <abstol> - Sets abstol 3053c7afd0dbSLois Curfman McInnes . -snes_rtol <rtol> - Sets rtol 3054c7afd0dbSLois Curfman McInnes . -snes_stol <stol> - Sets stol 3055c7afd0dbSLois Curfman McInnes . -snes_max_it <maxit> - Sets maxit 3056c7afd0dbSLois Curfman McInnes - -snes_max_funcs <maxf> - Sets maxf 30579b94acceSBarry Smith 3058d7a720efSLois Curfman McInnes Notes: 30599b94acceSBarry Smith The default maximum number of iterations is 50. 30609b94acceSBarry Smith The default maximum number of function evaluations is 1000. 30619b94acceSBarry Smith 306236851e7fSLois Curfman McInnes Level: intermediate 306336851e7fSLois Curfman McInnes 306433174efeSLois Curfman McInnes .keywords: SNES, nonlinear, set, convergence, tolerances 30659b94acceSBarry Smith 30662492ecdbSBarry Smith .seealso: SNESSetTrustRegionTolerance() 30679b94acceSBarry Smith @*/ 30687087cfbeSBarry Smith PetscErrorCode SNESSetTolerances(SNES snes,PetscReal abstol,PetscReal rtol,PetscReal stol,PetscInt maxit,PetscInt maxf) 30699b94acceSBarry Smith { 30703a40ed3dSBarry Smith PetscFunctionBegin; 30710700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 3072c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(snes,abstol,2); 3073c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(snes,rtol,3); 3074c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(snes,stol,4); 3075c5eb9154SBarry Smith PetscValidLogicalCollectiveInt(snes,maxit,5); 3076c5eb9154SBarry Smith PetscValidLogicalCollectiveInt(snes,maxf,6); 3077c5eb9154SBarry Smith 3078ab54825eSJed Brown if (abstol != PETSC_DEFAULT) { 3079ce94432eSBarry Smith if (abstol < 0.0) SETERRQ1(PetscObjectComm((PetscObject)snes),PETSC_ERR_ARG_OUTOFRANGE,"Absolute tolerance %G must be non-negative",abstol); 3080ab54825eSJed Brown snes->abstol = abstol; 3081ab54825eSJed Brown } 3082ab54825eSJed Brown if (rtol != PETSC_DEFAULT) { 3083ce94432eSBarry Smith if (rtol < 0.0 || 1.0 <= rtol) SETERRQ1(PetscObjectComm((PetscObject)snes),PETSC_ERR_ARG_OUTOFRANGE,"Relative tolerance %G must be non-negative and less than 1.0",rtol); 3084ab54825eSJed Brown snes->rtol = rtol; 3085ab54825eSJed Brown } 3086ab54825eSJed Brown if (stol != PETSC_DEFAULT) { 3087ce94432eSBarry Smith if (stol < 0.0) SETERRQ1(PetscObjectComm((PetscObject)snes),PETSC_ERR_ARG_OUTOFRANGE,"Step tolerance %G must be non-negative",stol); 3088c60f73f4SPeter Brune snes->stol = stol; 3089ab54825eSJed Brown } 3090ab54825eSJed Brown if (maxit != PETSC_DEFAULT) { 3091ce94432eSBarry Smith if (maxit < 0) SETERRQ1(PetscObjectComm((PetscObject)snes),PETSC_ERR_ARG_OUTOFRANGE,"Maximum number of iterations %D must be non-negative",maxit); 3092ab54825eSJed Brown snes->max_its = maxit; 3093ab54825eSJed Brown } 3094ab54825eSJed Brown if (maxf != PETSC_DEFAULT) { 3095ce94432eSBarry Smith if (maxf < 0) SETERRQ1(PetscObjectComm((PetscObject)snes),PETSC_ERR_ARG_OUTOFRANGE,"Maximum number of function evaluations %D must be non-negative",maxf); 3096ab54825eSJed Brown snes->max_funcs = maxf; 3097ab54825eSJed Brown } 309888976e71SPeter Brune snes->tolerancesset = PETSC_TRUE; 30993a40ed3dSBarry Smith PetscFunctionReturn(0); 31009b94acceSBarry Smith } 31019b94acceSBarry Smith 31024a2ae208SSatish Balay #undef __FUNCT__ 31034a2ae208SSatish Balay #define __FUNCT__ "SNESGetTolerances" 31049b94acceSBarry Smith /*@ 310533174efeSLois Curfman McInnes SNESGetTolerances - Gets various parameters used in convergence tests. 310633174efeSLois Curfman McInnes 3107c7afd0dbSLois Curfman McInnes Not Collective 3108c7afd0dbSLois Curfman McInnes 310933174efeSLois Curfman McInnes Input Parameters: 3110c7afd0dbSLois Curfman McInnes + snes - the SNES context 311185385478SLisandro Dalcin . atol - absolute convergence tolerance 311233174efeSLois Curfman McInnes . rtol - relative convergence tolerance 311333174efeSLois Curfman McInnes . stol - convergence tolerance in terms of the norm 311433174efeSLois Curfman McInnes of the change in the solution between steps 311533174efeSLois Curfman McInnes . maxit - maximum number of iterations 3116c7afd0dbSLois Curfman McInnes - maxf - maximum number of function evaluations 3117fee21e36SBarry Smith 311833174efeSLois Curfman McInnes Notes: 31190298fd71SBarry Smith The user can specify NULL for any parameter that is not needed. 312033174efeSLois Curfman McInnes 312136851e7fSLois Curfman McInnes Level: intermediate 312236851e7fSLois Curfman McInnes 312333174efeSLois Curfman McInnes .keywords: SNES, nonlinear, get, convergence, tolerances 312433174efeSLois Curfman McInnes 312533174efeSLois Curfman McInnes .seealso: SNESSetTolerances() 312633174efeSLois Curfman McInnes @*/ 31277087cfbeSBarry Smith PetscErrorCode SNESGetTolerances(SNES snes,PetscReal *atol,PetscReal *rtol,PetscReal *stol,PetscInt *maxit,PetscInt *maxf) 312833174efeSLois Curfman McInnes { 31293a40ed3dSBarry Smith PetscFunctionBegin; 31300700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 313185385478SLisandro Dalcin if (atol) *atol = snes->abstol; 313233174efeSLois Curfman McInnes if (rtol) *rtol = snes->rtol; 3133c60f73f4SPeter Brune if (stol) *stol = snes->stol; 313433174efeSLois Curfman McInnes if (maxit) *maxit = snes->max_its; 313533174efeSLois Curfman McInnes if (maxf) *maxf = snes->max_funcs; 31363a40ed3dSBarry Smith PetscFunctionReturn(0); 313733174efeSLois Curfman McInnes } 313833174efeSLois Curfman McInnes 31394a2ae208SSatish Balay #undef __FUNCT__ 31404a2ae208SSatish Balay #define __FUNCT__ "SNESSetTrustRegionTolerance" 314133174efeSLois Curfman McInnes /*@ 31429b94acceSBarry Smith SNESSetTrustRegionTolerance - Sets the trust region parameter tolerance. 31439b94acceSBarry Smith 31443f9fe445SBarry Smith Logically Collective on SNES 3145fee21e36SBarry Smith 3146c7afd0dbSLois Curfman McInnes Input Parameters: 3147c7afd0dbSLois Curfman McInnes + snes - the SNES context 3148c7afd0dbSLois Curfman McInnes - tol - tolerance 3149c7afd0dbSLois Curfman McInnes 31509b94acceSBarry Smith Options Database Key: 3151c7afd0dbSLois Curfman McInnes . -snes_trtol <tol> - Sets tol 31529b94acceSBarry Smith 315336851e7fSLois Curfman McInnes Level: intermediate 315436851e7fSLois Curfman McInnes 31559b94acceSBarry Smith .keywords: SNES, nonlinear, set, trust region, tolerance 31569b94acceSBarry Smith 31572492ecdbSBarry Smith .seealso: SNESSetTolerances() 31589b94acceSBarry Smith @*/ 31597087cfbeSBarry Smith PetscErrorCode SNESSetTrustRegionTolerance(SNES snes,PetscReal tol) 31609b94acceSBarry Smith { 31613a40ed3dSBarry Smith PetscFunctionBegin; 31620700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 3163c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(snes,tol,2); 31649b94acceSBarry Smith snes->deltatol = tol; 31653a40ed3dSBarry Smith PetscFunctionReturn(0); 31669b94acceSBarry Smith } 31679b94acceSBarry Smith 3168df9fa365SBarry Smith /* 3169df9fa365SBarry Smith Duplicate the lg monitors for SNES from KSP; for some reason with 3170df9fa365SBarry Smith dynamic libraries things don't work under Sun4 if we just use 3171df9fa365SBarry Smith macros instead of functions 3172df9fa365SBarry Smith */ 31734a2ae208SSatish Balay #undef __FUNCT__ 31744619e776SBarry Smith #define __FUNCT__ "SNESMonitorLGResidualNorm" 31754619e776SBarry Smith PetscErrorCode SNESMonitorLGResidualNorm(SNES snes,PetscInt it,PetscReal norm,void *ctx) 3176ce1608b8SBarry Smith { 3177dfbe8321SBarry Smith PetscErrorCode ierr; 3178ce1608b8SBarry Smith 3179ce1608b8SBarry Smith PetscFunctionBegin; 31800700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 31811d1e9da1SBarry Smith ierr = KSPMonitorLGResidualNorm((KSP)snes,it,norm,ctx);CHKERRQ(ierr); 3182ce1608b8SBarry Smith PetscFunctionReturn(0); 3183ce1608b8SBarry Smith } 3184ce1608b8SBarry Smith 31854a2ae208SSatish Balay #undef __FUNCT__ 3186a6570f20SBarry Smith #define __FUNCT__ "SNESMonitorLGCreate" 31877087cfbeSBarry Smith PetscErrorCode SNESMonitorLGCreate(const char host[],const char label[],int x,int y,int m,int n,PetscDrawLG *draw) 3188df9fa365SBarry Smith { 3189dfbe8321SBarry Smith PetscErrorCode ierr; 3190df9fa365SBarry Smith 3191df9fa365SBarry Smith PetscFunctionBegin; 31921d1e9da1SBarry Smith ierr = KSPMonitorLGResidualNormCreate(host,label,x,y,m,n,draw);CHKERRQ(ierr); 3193df9fa365SBarry Smith PetscFunctionReturn(0); 3194df9fa365SBarry Smith } 3195df9fa365SBarry Smith 31964a2ae208SSatish Balay #undef __FUNCT__ 3197a6570f20SBarry Smith #define __FUNCT__ "SNESMonitorLGDestroy" 31986bf464f9SBarry Smith PetscErrorCode SNESMonitorLGDestroy(PetscDrawLG *draw) 3199df9fa365SBarry Smith { 3200dfbe8321SBarry Smith PetscErrorCode ierr; 3201df9fa365SBarry Smith 3202df9fa365SBarry Smith PetscFunctionBegin; 32031d1e9da1SBarry Smith ierr = KSPMonitorLGResidualNormDestroy(draw);CHKERRQ(ierr); 3204df9fa365SBarry Smith PetscFunctionReturn(0); 3205df9fa365SBarry Smith } 3206df9fa365SBarry Smith 32077087cfbeSBarry Smith extern PetscErrorCode SNESMonitorRange_Private(SNES,PetscInt,PetscReal*); 3208b271bb04SBarry Smith #undef __FUNCT__ 3209b271bb04SBarry Smith #define __FUNCT__ "SNESMonitorLGRange" 32107087cfbeSBarry Smith PetscErrorCode SNESMonitorLGRange(SNES snes,PetscInt n,PetscReal rnorm,void *monctx) 3211b271bb04SBarry Smith { 3212b271bb04SBarry Smith PetscDrawLG lg; 3213b271bb04SBarry Smith PetscErrorCode ierr; 3214b271bb04SBarry Smith PetscReal x,y,per; 3215b271bb04SBarry Smith PetscViewer v = (PetscViewer)monctx; 3216b271bb04SBarry Smith static PetscReal prev; /* should be in the context */ 3217b271bb04SBarry Smith PetscDraw draw; 3218b271bb04SBarry Smith 3219459f5d12SBarry Smith PetscFunctionBegin; 3220b271bb04SBarry Smith ierr = PetscViewerDrawGetDrawLG(v,0,&lg);CHKERRQ(ierr); 3221b271bb04SBarry Smith if (!n) {ierr = PetscDrawLGReset(lg);CHKERRQ(ierr);} 3222b271bb04SBarry Smith ierr = PetscDrawLGGetDraw(lg,&draw);CHKERRQ(ierr); 3223b271bb04SBarry Smith ierr = PetscDrawSetTitle(draw,"Residual norm");CHKERRQ(ierr); 3224b271bb04SBarry Smith x = (PetscReal)n; 322594c9c6d3SKarl Rupp if (rnorm > 0.0) y = log10(rnorm); 322694c9c6d3SKarl Rupp else y = -15.0; 3227b271bb04SBarry Smith ierr = PetscDrawLGAddPoint(lg,&x,&y);CHKERRQ(ierr); 3228b271bb04SBarry Smith if (n < 20 || !(n % 5)) { 3229b271bb04SBarry Smith ierr = PetscDrawLGDraw(lg);CHKERRQ(ierr); 3230b271bb04SBarry Smith } 3231b271bb04SBarry Smith 3232b271bb04SBarry Smith ierr = PetscViewerDrawGetDrawLG(v,1,&lg);CHKERRQ(ierr); 3233b271bb04SBarry Smith if (!n) {ierr = PetscDrawLGReset(lg);CHKERRQ(ierr);} 3234b271bb04SBarry Smith ierr = PetscDrawLGGetDraw(lg,&draw);CHKERRQ(ierr); 3235b271bb04SBarry Smith ierr = PetscDrawSetTitle(draw,"% elemts > .2*max elemt");CHKERRQ(ierr); 3236b271bb04SBarry Smith ierr = SNESMonitorRange_Private(snes,n,&per);CHKERRQ(ierr); 3237b271bb04SBarry Smith x = (PetscReal)n; 3238b271bb04SBarry Smith y = 100.0*per; 3239b271bb04SBarry Smith ierr = PetscDrawLGAddPoint(lg,&x,&y);CHKERRQ(ierr); 3240b271bb04SBarry Smith if (n < 20 || !(n % 5)) { 3241b271bb04SBarry Smith ierr = PetscDrawLGDraw(lg);CHKERRQ(ierr); 3242b271bb04SBarry Smith } 3243b271bb04SBarry Smith 3244b271bb04SBarry Smith ierr = PetscViewerDrawGetDrawLG(v,2,&lg);CHKERRQ(ierr); 3245b271bb04SBarry Smith if (!n) {prev = rnorm;ierr = PetscDrawLGReset(lg);CHKERRQ(ierr);} 3246b271bb04SBarry Smith ierr = PetscDrawLGGetDraw(lg,&draw);CHKERRQ(ierr); 3247b271bb04SBarry Smith ierr = PetscDrawSetTitle(draw,"(norm -oldnorm)/oldnorm");CHKERRQ(ierr); 3248b271bb04SBarry Smith x = (PetscReal)n; 3249b271bb04SBarry Smith y = (prev - rnorm)/prev; 3250b271bb04SBarry Smith ierr = PetscDrawLGAddPoint(lg,&x,&y);CHKERRQ(ierr); 3251b271bb04SBarry Smith if (n < 20 || !(n % 5)) { 3252b271bb04SBarry Smith ierr = PetscDrawLGDraw(lg);CHKERRQ(ierr); 3253b271bb04SBarry Smith } 3254b271bb04SBarry Smith 3255b271bb04SBarry Smith ierr = PetscViewerDrawGetDrawLG(v,3,&lg);CHKERRQ(ierr); 3256b271bb04SBarry Smith if (!n) {ierr = PetscDrawLGReset(lg);CHKERRQ(ierr);} 3257b271bb04SBarry Smith ierr = PetscDrawLGGetDraw(lg,&draw);CHKERRQ(ierr); 3258b271bb04SBarry Smith ierr = PetscDrawSetTitle(draw,"(norm -oldnorm)/oldnorm*(% > .2 max)");CHKERRQ(ierr); 3259b271bb04SBarry Smith x = (PetscReal)n; 3260b271bb04SBarry Smith y = (prev - rnorm)/(prev*per); 3261b271bb04SBarry Smith if (n > 2) { /*skip initial crazy value */ 3262b271bb04SBarry Smith ierr = PetscDrawLGAddPoint(lg,&x,&y);CHKERRQ(ierr); 3263b271bb04SBarry Smith } 3264b271bb04SBarry Smith if (n < 20 || !(n % 5)) { 3265b271bb04SBarry Smith ierr = PetscDrawLGDraw(lg);CHKERRQ(ierr); 3266b271bb04SBarry Smith } 3267b271bb04SBarry Smith prev = rnorm; 3268b271bb04SBarry Smith PetscFunctionReturn(0); 3269b271bb04SBarry Smith } 3270b271bb04SBarry Smith 3271b271bb04SBarry Smith #undef __FUNCT__ 32727a03ce2fSLisandro Dalcin #define __FUNCT__ "SNESMonitor" 3273228d79bcSJed Brown /*@ 3274228d79bcSJed Brown SNESMonitor - runs the user provided monitor routines, if they exist 3275228d79bcSJed Brown 3276228d79bcSJed Brown Collective on SNES 3277228d79bcSJed Brown 3278228d79bcSJed Brown Input Parameters: 3279228d79bcSJed Brown + snes - nonlinear solver context obtained from SNESCreate() 3280228d79bcSJed Brown . iter - iteration number 3281228d79bcSJed Brown - rnorm - relative norm of the residual 3282228d79bcSJed Brown 3283228d79bcSJed Brown Notes: 3284228d79bcSJed Brown This routine is called by the SNES implementations. 3285228d79bcSJed Brown It does not typically need to be called by the user. 3286228d79bcSJed Brown 3287228d79bcSJed Brown Level: developer 3288228d79bcSJed Brown 3289228d79bcSJed Brown .seealso: SNESMonitorSet() 3290228d79bcSJed Brown @*/ 32917a03ce2fSLisandro Dalcin PetscErrorCode SNESMonitor(SNES snes,PetscInt iter,PetscReal rnorm) 32927a03ce2fSLisandro Dalcin { 32937a03ce2fSLisandro Dalcin PetscErrorCode ierr; 32947a03ce2fSLisandro Dalcin PetscInt i,n = snes->numbermonitors; 32957a03ce2fSLisandro Dalcin 32967a03ce2fSLisandro Dalcin PetscFunctionBegin; 32977a03ce2fSLisandro Dalcin for (i=0; i<n; i++) { 32987a03ce2fSLisandro Dalcin ierr = (*snes->monitor[i])(snes,iter,rnorm,snes->monitorcontext[i]);CHKERRQ(ierr); 32997a03ce2fSLisandro Dalcin } 33007a03ce2fSLisandro Dalcin PetscFunctionReturn(0); 33017a03ce2fSLisandro Dalcin } 33027a03ce2fSLisandro Dalcin 33039b94acceSBarry Smith /* ------------ Routines to set performance monitoring options ----------- */ 33049b94acceSBarry Smith 3305bf388a1fSBarry Smith /*MC 3306bf388a1fSBarry Smith SNESMonitorFunction - functional form passed to SNESMonitorSet() to monitor convergence of nonlinear solver 3307bf388a1fSBarry Smith 3308bf388a1fSBarry Smith Synopsis: 3309bf388a1fSBarry Smith #include "petscsnes.h" 3310bf388a1fSBarry Smith $ PetscErrorCode SNESMonitorFunction(SNES snes,PetscInt its, PetscReal norm,void *mctx) 3311bf388a1fSBarry Smith 3312bf388a1fSBarry Smith + snes - the SNES context 3313bf388a1fSBarry Smith . its - iteration number 3314bf388a1fSBarry Smith . norm - 2-norm function value (may be estimated) 3315bf388a1fSBarry Smith - mctx - [optional] monitoring context 3316bf388a1fSBarry Smith 3317878cb397SSatish Balay Level: advanced 3318878cb397SSatish Balay 3319bf388a1fSBarry Smith .seealso: SNESMonitorSet(), SNESMonitorGet() 3320bf388a1fSBarry Smith M*/ 3321bf388a1fSBarry Smith 33224a2ae208SSatish Balay #undef __FUNCT__ 3323a6570f20SBarry Smith #define __FUNCT__ "SNESMonitorSet" 33249b94acceSBarry Smith /*@C 3325a6570f20SBarry Smith SNESMonitorSet - Sets an ADDITIONAL function that is to be used at every 33269b94acceSBarry Smith iteration of the nonlinear solver to display the iteration's 33279b94acceSBarry Smith progress. 33289b94acceSBarry Smith 33293f9fe445SBarry Smith Logically Collective on SNES 3330fee21e36SBarry Smith 3331c7afd0dbSLois Curfman McInnes Input Parameters: 3332c7afd0dbSLois Curfman McInnes + snes - the SNES context 3333bf388a1fSBarry Smith . SNESMonitorFunction - monitoring routine 3334b8a78c4aSBarry Smith . mctx - [optional] user-defined context for private data for the 33350298fd71SBarry Smith monitor routine (use NULL if no context is desired) 3336b3006f0bSLois Curfman McInnes - monitordestroy - [optional] routine that frees monitor context 33370298fd71SBarry Smith (may be NULL) 33389b94acceSBarry Smith 33399665c990SLois Curfman McInnes Options Database Keys: 3340a6570f20SBarry Smith + -snes_monitor - sets SNESMonitorDefault() 33414619e776SBarry Smith . -snes_monitor_lg_residualnorm - sets line graph monitor, 3342a6570f20SBarry Smith uses SNESMonitorLGCreate() 3343cca6129bSJed Brown - -snes_monitor_cancel - cancels all monitors that have 3344c7afd0dbSLois Curfman McInnes been hardwired into a code by 3345a6570f20SBarry Smith calls to SNESMonitorSet(), but 3346c7afd0dbSLois Curfman McInnes does not cancel those set via 3347c7afd0dbSLois Curfman McInnes the options database. 33489665c990SLois Curfman McInnes 3349639f9d9dSBarry Smith Notes: 33506bc08f3fSLois Curfman McInnes Several different monitoring routines may be set by calling 3351a6570f20SBarry Smith SNESMonitorSet() multiple times; all will be called in the 33526bc08f3fSLois Curfman McInnes order in which they were set. 3353639f9d9dSBarry Smith 3354025f1a04SBarry Smith Fortran notes: Only a single monitor function can be set for each SNES object 3355025f1a04SBarry Smith 335636851e7fSLois Curfman McInnes Level: intermediate 335736851e7fSLois Curfman McInnes 33589b94acceSBarry Smith .keywords: SNES, nonlinear, set, monitor 33599b94acceSBarry Smith 3360bf388a1fSBarry Smith .seealso: SNESMonitorDefault(), SNESMonitorCancel(), SNESMonitorFunction 33619b94acceSBarry Smith @*/ 3362bf388a1fSBarry Smith PetscErrorCode SNESMonitorSet(SNES snes,PetscErrorCode (*SNESMonitorFunction)(SNES,PetscInt,PetscReal,void*),void *mctx,PetscErrorCode (*monitordestroy)(void**)) 33639b94acceSBarry Smith { 3364b90d0a6eSBarry Smith PetscInt i; 3365649052a6SBarry Smith PetscErrorCode ierr; 3366b90d0a6eSBarry Smith 33673a40ed3dSBarry Smith PetscFunctionBegin; 33680700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 336917186662SBarry Smith if (snes->numbermonitors >= MAXSNESMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many monitors set"); 3370b90d0a6eSBarry Smith for (i=0; i<snes->numbermonitors;i++) { 3371bf388a1fSBarry Smith if (SNESMonitorFunction == snes->monitor[i] && monitordestroy == snes->monitordestroy[i] && mctx == snes->monitorcontext[i]) { 3372649052a6SBarry Smith if (monitordestroy) { 3373c2efdce3SBarry Smith ierr = (*monitordestroy)(&mctx);CHKERRQ(ierr); 3374649052a6SBarry Smith } 3375b90d0a6eSBarry Smith PetscFunctionReturn(0); 3376b90d0a6eSBarry Smith } 3377b90d0a6eSBarry Smith } 3378bf388a1fSBarry Smith snes->monitor[snes->numbermonitors] = SNESMonitorFunction; 3379b8a78c4aSBarry Smith snes->monitordestroy[snes->numbermonitors] = monitordestroy; 3380639f9d9dSBarry Smith snes->monitorcontext[snes->numbermonitors++] = (void*)mctx; 33813a40ed3dSBarry Smith PetscFunctionReturn(0); 33829b94acceSBarry Smith } 33839b94acceSBarry Smith 33844a2ae208SSatish Balay #undef __FUNCT__ 3385a6570f20SBarry Smith #define __FUNCT__ "SNESMonitorCancel" 3386a278d85bSSatish Balay /*@ 3387a6570f20SBarry Smith SNESMonitorCancel - Clears all the monitor functions for a SNES object. 33885cd90555SBarry Smith 33893f9fe445SBarry Smith Logically Collective on SNES 3390c7afd0dbSLois Curfman McInnes 33915cd90555SBarry Smith Input Parameters: 33925cd90555SBarry Smith . snes - the SNES context 33935cd90555SBarry Smith 33941a480d89SAdministrator Options Database Key: 3395a6570f20SBarry Smith . -snes_monitor_cancel - cancels all monitors that have been hardwired 3396a6570f20SBarry Smith into a code by calls to SNESMonitorSet(), but does not cancel those 3397c7afd0dbSLois Curfman McInnes set via the options database 33985cd90555SBarry Smith 33995cd90555SBarry Smith Notes: 34005cd90555SBarry Smith There is no way to clear one specific monitor from a SNES object. 34015cd90555SBarry Smith 340236851e7fSLois Curfman McInnes Level: intermediate 340336851e7fSLois Curfman McInnes 34045cd90555SBarry Smith .keywords: SNES, nonlinear, set, monitor 34055cd90555SBarry Smith 3406a6570f20SBarry Smith .seealso: SNESMonitorDefault(), SNESMonitorSet() 34075cd90555SBarry Smith @*/ 34087087cfbeSBarry Smith PetscErrorCode SNESMonitorCancel(SNES snes) 34095cd90555SBarry Smith { 3410d952e501SBarry Smith PetscErrorCode ierr; 3411d952e501SBarry Smith PetscInt i; 3412d952e501SBarry Smith 34135cd90555SBarry Smith PetscFunctionBegin; 34140700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 3415d952e501SBarry Smith for (i=0; i<snes->numbermonitors; i++) { 3416d952e501SBarry Smith if (snes->monitordestroy[i]) { 34173c4aec1bSBarry Smith ierr = (*snes->monitordestroy[i])(&snes->monitorcontext[i]);CHKERRQ(ierr); 3418d952e501SBarry Smith } 3419d952e501SBarry Smith } 34205cd90555SBarry Smith snes->numbermonitors = 0; 34215cd90555SBarry Smith PetscFunctionReturn(0); 34225cd90555SBarry Smith } 34235cd90555SBarry Smith 3424bf388a1fSBarry Smith /*MC 3425bf388a1fSBarry Smith SNESConvergenceTestFunction - functional form used for testing of convergence of nonlinear solver 3426bf388a1fSBarry Smith 3427bf388a1fSBarry Smith Synopsis: 3428bf388a1fSBarry Smith #include "petscsnes.h" 3429bf388a1fSBarry Smith $ PetscErrorCode SNESConvergenceTest(SNES snes,PetscInt it,PetscReal xnorm,PetscReal gnorm,PetscReal f,SNESConvergedReason *reason,void *cctx) 3430bf388a1fSBarry Smith 3431bf388a1fSBarry Smith + snes - the SNES context 3432bf388a1fSBarry Smith . it - current iteration (0 is the first and is before any Newton step) 3433bf388a1fSBarry Smith . cctx - [optional] convergence context 3434bf388a1fSBarry Smith . reason - reason for convergence/divergence 3435bf388a1fSBarry Smith . xnorm - 2-norm of current iterate 3436bf388a1fSBarry Smith . gnorm - 2-norm of current step 3437bf388a1fSBarry Smith - f - 2-norm of function 3438bf388a1fSBarry Smith 3439878cb397SSatish Balay Level: intermediate 3440bf388a1fSBarry Smith 3441bf388a1fSBarry Smith .seealso: SNESSetConvergenceTest(), SNESGetConvergenceTest() 3442bf388a1fSBarry Smith M*/ 3443bf388a1fSBarry Smith 34444a2ae208SSatish Balay #undef __FUNCT__ 34454a2ae208SSatish Balay #define __FUNCT__ "SNESSetConvergenceTest" 34469b94acceSBarry Smith /*@C 34479b94acceSBarry Smith SNESSetConvergenceTest - Sets the function that is to be used 34489b94acceSBarry Smith to test for convergence of the nonlinear iterative solution. 34499b94acceSBarry Smith 34503f9fe445SBarry Smith Logically Collective on SNES 3451fee21e36SBarry Smith 3452c7afd0dbSLois Curfman McInnes Input Parameters: 3453c7afd0dbSLois Curfman McInnes + snes - the SNES context 3454bf388a1fSBarry Smith . SNESConvergenceTestFunction - routine to test for convergence 34550298fd71SBarry Smith . cctx - [optional] context for private data for the convergence routine (may be NULL) 34560298fd71SBarry Smith - destroy - [optional] destructor for the context (may be NULL; NULL_FUNCTION in Fortran) 34579b94acceSBarry Smith 345836851e7fSLois Curfman McInnes Level: advanced 345936851e7fSLois Curfman McInnes 34609b94acceSBarry Smith .keywords: SNES, nonlinear, set, convergence, test 34619b94acceSBarry Smith 34628d359177SBarry Smith .seealso: SNESConvergedDefault(), SNESSkipConverged(), SNESConvergenceTestFunction 34639b94acceSBarry Smith @*/ 3464bf388a1fSBarry Smith PetscErrorCode SNESSetConvergenceTest(SNES snes,PetscErrorCode (*SNESConvergenceTestFunction)(SNES,PetscInt,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*),void *cctx,PetscErrorCode (*destroy)(void*)) 34659b94acceSBarry Smith { 34667f7931b9SBarry Smith PetscErrorCode ierr; 34677f7931b9SBarry Smith 34683a40ed3dSBarry Smith PetscFunctionBegin; 34690700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 3470bf388a1fSBarry Smith if (!SNESConvergenceTestFunction) SNESConvergenceTestFunction = SNESSkipConverged; 34717f7931b9SBarry Smith if (snes->ops->convergeddestroy) { 34727f7931b9SBarry Smith ierr = (*snes->ops->convergeddestroy)(snes->cnvP);CHKERRQ(ierr); 34737f7931b9SBarry Smith } 3474bf388a1fSBarry Smith snes->ops->converged = SNESConvergenceTestFunction; 34757f7931b9SBarry Smith snes->ops->convergeddestroy = destroy; 347685385478SLisandro Dalcin snes->cnvP = cctx; 34773a40ed3dSBarry Smith PetscFunctionReturn(0); 34789b94acceSBarry Smith } 34799b94acceSBarry Smith 34804a2ae208SSatish Balay #undef __FUNCT__ 34814a2ae208SSatish Balay #define __FUNCT__ "SNESGetConvergedReason" 348252baeb72SSatish Balay /*@ 3483184914b5SBarry Smith SNESGetConvergedReason - Gets the reason the SNES iteration was stopped. 3484184914b5SBarry Smith 3485184914b5SBarry Smith Not Collective 3486184914b5SBarry Smith 3487184914b5SBarry Smith Input Parameter: 3488184914b5SBarry Smith . snes - the SNES context 3489184914b5SBarry Smith 3490184914b5SBarry Smith Output Parameter: 34914d0a8057SBarry Smith . reason - negative value indicates diverged, positive value converged, see SNESConvergedReason or the 3492184914b5SBarry Smith manual pages for the individual convergence tests for complete lists 3493184914b5SBarry Smith 3494184914b5SBarry Smith Level: intermediate 3495184914b5SBarry Smith 3496184914b5SBarry Smith Notes: Can only be called after the call the SNESSolve() is complete. 3497184914b5SBarry Smith 3498184914b5SBarry Smith .keywords: SNES, nonlinear, set, convergence, test 3499184914b5SBarry Smith 350085385478SLisandro Dalcin .seealso: SNESSetConvergenceTest(), SNESConvergedReason 3501184914b5SBarry Smith @*/ 35027087cfbeSBarry Smith PetscErrorCode SNESGetConvergedReason(SNES snes,SNESConvergedReason *reason) 3503184914b5SBarry Smith { 3504184914b5SBarry Smith PetscFunctionBegin; 35050700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 35064482741eSBarry Smith PetscValidPointer(reason,2); 3507184914b5SBarry Smith *reason = snes->reason; 3508184914b5SBarry Smith PetscFunctionReturn(0); 3509184914b5SBarry Smith } 3510184914b5SBarry Smith 35114a2ae208SSatish Balay #undef __FUNCT__ 35124a2ae208SSatish Balay #define __FUNCT__ "SNESSetConvergenceHistory" 3513c9005455SLois Curfman McInnes /*@ 3514c9005455SLois Curfman McInnes SNESSetConvergenceHistory - Sets the array used to hold the convergence history. 3515c9005455SLois Curfman McInnes 35163f9fe445SBarry Smith Logically Collective on SNES 3517fee21e36SBarry Smith 3518c7afd0dbSLois Curfman McInnes Input Parameters: 3519c7afd0dbSLois Curfman McInnes + snes - iterative context obtained from SNESCreate() 35208c7482ecSBarry Smith . a - array to hold history, this array will contain the function norms computed at each step 3521cd5578b5SBarry Smith . its - integer array holds the number of linear iterations for each solve. 3522758f92a0SBarry Smith . na - size of a and its 352364731454SLois Curfman McInnes - reset - PETSC_TRUE indicates each new nonlinear solve resets the history counter to zero, 3524758f92a0SBarry Smith else it continues storing new values for new nonlinear solves after the old ones 3525c7afd0dbSLois Curfman McInnes 3526308dcc3eSBarry Smith Notes: 35270298fd71SBarry Smith If 'a' and 'its' are NULL then space is allocated for the history. If 'na' PETSC_DECIDE or PETSC_DEFAULT then a 3528308dcc3eSBarry Smith default array of length 10000 is allocated. 3529308dcc3eSBarry Smith 3530c9005455SLois Curfman McInnes This routine is useful, e.g., when running a code for purposes 3531c9005455SLois Curfman McInnes of accurate performance monitoring, when no I/O should be done 3532c9005455SLois Curfman McInnes during the section of code that is being timed. 3533c9005455SLois Curfman McInnes 353436851e7fSLois Curfman McInnes Level: intermediate 353536851e7fSLois Curfman McInnes 3536c9005455SLois Curfman McInnes .keywords: SNES, set, convergence, history 3537758f92a0SBarry Smith 353808405cd6SLois Curfman McInnes .seealso: SNESGetConvergenceHistory() 3539758f92a0SBarry Smith 3540c9005455SLois Curfman McInnes @*/ 35417087cfbeSBarry Smith PetscErrorCode SNESSetConvergenceHistory(SNES snes,PetscReal a[],PetscInt its[],PetscInt na,PetscBool reset) 3542c9005455SLois Curfman McInnes { 3543308dcc3eSBarry Smith PetscErrorCode ierr; 3544308dcc3eSBarry Smith 35453a40ed3dSBarry Smith PetscFunctionBegin; 35460700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 35477a1ec6d4SBarry Smith if (a) PetscValidScalarPointer(a,2); 3548a562a398SLisandro Dalcin if (its) PetscValidIntPointer(its,3); 35497a1ec6d4SBarry Smith if (!a) { 3550308dcc3eSBarry Smith if (na == PETSC_DECIDE || na == PETSC_DEFAULT) na = 1000; 3551308dcc3eSBarry Smith ierr = PetscMalloc(na*sizeof(PetscReal),&a);CHKERRQ(ierr); 3552308dcc3eSBarry Smith ierr = PetscMalloc(na*sizeof(PetscInt),&its);CHKERRQ(ierr); 3553f5af7f23SKarl Rupp 3554308dcc3eSBarry Smith snes->conv_malloc = PETSC_TRUE; 3555308dcc3eSBarry Smith } 3556c9005455SLois Curfman McInnes snes->conv_hist = a; 3557758f92a0SBarry Smith snes->conv_hist_its = its; 3558758f92a0SBarry Smith snes->conv_hist_max = na; 3559a12bc48fSLisandro Dalcin snes->conv_hist_len = 0; 3560758f92a0SBarry Smith snes->conv_hist_reset = reset; 3561758f92a0SBarry Smith PetscFunctionReturn(0); 3562758f92a0SBarry Smith } 3563758f92a0SBarry Smith 3564308dcc3eSBarry Smith #if defined(PETSC_HAVE_MATLAB_ENGINE) 3565c6db04a5SJed Brown #include <engine.h> /* MATLAB include file */ 3566c6db04a5SJed Brown #include <mex.h> /* MATLAB include file */ 356799e0435eSBarry Smith 3568308dcc3eSBarry Smith #undef __FUNCT__ 3569308dcc3eSBarry Smith #define __FUNCT__ "SNESGetConvergenceHistoryMatlab" 35708cc058d9SJed Brown PETSC_EXTERN mxArray *SNESGetConvergenceHistoryMatlab(SNES snes) 3571308dcc3eSBarry Smith { 3572308dcc3eSBarry Smith mxArray *mat; 3573308dcc3eSBarry Smith PetscInt i; 3574308dcc3eSBarry Smith PetscReal *ar; 3575308dcc3eSBarry Smith 3576308dcc3eSBarry Smith PetscFunctionBegin; 3577308dcc3eSBarry Smith mat = mxCreateDoubleMatrix(snes->conv_hist_len,1,mxREAL); 3578308dcc3eSBarry Smith ar = (PetscReal*) mxGetData(mat); 3579f5af7f23SKarl Rupp for (i=0; i<snes->conv_hist_len; i++) ar[i] = snes->conv_hist[i]; 3580308dcc3eSBarry Smith PetscFunctionReturn(mat); 3581308dcc3eSBarry Smith } 3582308dcc3eSBarry Smith #endif 3583308dcc3eSBarry Smith 35844a2ae208SSatish Balay #undef __FUNCT__ 35854a2ae208SSatish Balay #define __FUNCT__ "SNESGetConvergenceHistory" 35860c4c9dddSBarry Smith /*@C 3587758f92a0SBarry Smith SNESGetConvergenceHistory - Gets the array used to hold the convergence history. 3588758f92a0SBarry Smith 35893f9fe445SBarry Smith Not Collective 3590758f92a0SBarry Smith 3591758f92a0SBarry Smith Input Parameter: 3592758f92a0SBarry Smith . snes - iterative context obtained from SNESCreate() 3593758f92a0SBarry Smith 3594758f92a0SBarry Smith Output Parameters: 3595758f92a0SBarry Smith . a - array to hold history 3596758f92a0SBarry Smith . its - integer array holds the number of linear iterations (or 3597758f92a0SBarry Smith negative if not converged) for each solve. 3598758f92a0SBarry Smith - na - size of a and its 3599758f92a0SBarry Smith 3600758f92a0SBarry Smith Notes: 3601758f92a0SBarry Smith The calling sequence for this routine in Fortran is 3602758f92a0SBarry Smith $ call SNESGetConvergenceHistory(SNES snes, integer na, integer ierr) 3603758f92a0SBarry Smith 3604758f92a0SBarry Smith This routine is useful, e.g., when running a code for purposes 3605758f92a0SBarry Smith of accurate performance monitoring, when no I/O should be done 3606758f92a0SBarry Smith during the section of code that is being timed. 3607758f92a0SBarry Smith 3608758f92a0SBarry Smith Level: intermediate 3609758f92a0SBarry Smith 3610758f92a0SBarry Smith .keywords: SNES, get, convergence, history 3611758f92a0SBarry Smith 3612758f92a0SBarry Smith .seealso: SNESSetConvergencHistory() 3613758f92a0SBarry Smith 3614758f92a0SBarry Smith @*/ 36157087cfbeSBarry Smith PetscErrorCode SNESGetConvergenceHistory(SNES snes,PetscReal *a[],PetscInt *its[],PetscInt *na) 3616758f92a0SBarry Smith { 3617758f92a0SBarry Smith PetscFunctionBegin; 36180700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 3619758f92a0SBarry Smith if (a) *a = snes->conv_hist; 3620758f92a0SBarry Smith if (its) *its = snes->conv_hist_its; 3621758f92a0SBarry Smith if (na) *na = snes->conv_hist_len; 36223a40ed3dSBarry Smith PetscFunctionReturn(0); 3623c9005455SLois Curfman McInnes } 3624c9005455SLois Curfman McInnes 3625e74ef692SMatthew Knepley #undef __FUNCT__ 3626e74ef692SMatthew Knepley #define __FUNCT__ "SNESSetUpdate" 3627ac226902SBarry Smith /*@C 362876b2cf59SMatthew Knepley SNESSetUpdate - Sets the general-purpose update function called 3629eec8f646SJed Brown at the beginning of every iteration of the nonlinear solve. Specifically 36307e4bb74cSBarry Smith it is called just before the Jacobian is "evaluated". 363176b2cf59SMatthew Knepley 36323f9fe445SBarry Smith Logically Collective on SNES 363376b2cf59SMatthew Knepley 363476b2cf59SMatthew Knepley Input Parameters: 363576b2cf59SMatthew Knepley . snes - The nonlinear solver context 363676b2cf59SMatthew Knepley . func - The function 363776b2cf59SMatthew Knepley 363876b2cf59SMatthew Knepley Calling sequence of func: 3639b5d30489SBarry Smith . func (SNES snes, PetscInt step); 364076b2cf59SMatthew Knepley 364176b2cf59SMatthew Knepley . step - The current step of the iteration 364276b2cf59SMatthew Knepley 3643fe97e370SBarry Smith Level: advanced 3644fe97e370SBarry Smith 3645fe97e370SBarry 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() 3646fe97e370SBarry Smith This is not used by most users. 364776b2cf59SMatthew Knepley 364876b2cf59SMatthew Knepley .keywords: SNES, update 3649b5d30489SBarry Smith 36508d359177SBarry Smith .seealso SNESSetJacobian(), SNESSolve() 365176b2cf59SMatthew Knepley @*/ 36527087cfbeSBarry Smith PetscErrorCode SNESSetUpdate(SNES snes, PetscErrorCode (*func)(SNES, PetscInt)) 365376b2cf59SMatthew Knepley { 365476b2cf59SMatthew Knepley PetscFunctionBegin; 36550700a824SBarry Smith PetscValidHeaderSpecific(snes, SNES_CLASSID,1); 3656e7788613SBarry Smith snes->ops->update = func; 365776b2cf59SMatthew Knepley PetscFunctionReturn(0); 365876b2cf59SMatthew Knepley } 365976b2cf59SMatthew Knepley 3660e74ef692SMatthew Knepley #undef __FUNCT__ 36614a2ae208SSatish Balay #define __FUNCT__ "SNESScaleStep_Private" 36629b94acceSBarry Smith /* 36639b94acceSBarry Smith SNESScaleStep_Private - Scales a step so that its length is less than the 36649b94acceSBarry Smith positive parameter delta. 36659b94acceSBarry Smith 36669b94acceSBarry Smith Input Parameters: 3667c7afd0dbSLois Curfman McInnes + snes - the SNES context 36689b94acceSBarry Smith . y - approximate solution of linear system 36699b94acceSBarry Smith . fnorm - 2-norm of current function 3670c7afd0dbSLois Curfman McInnes - delta - trust region size 36719b94acceSBarry Smith 36729b94acceSBarry Smith Output Parameters: 3673c7afd0dbSLois Curfman McInnes + gpnorm - predicted function norm at the new point, assuming local 36749b94acceSBarry Smith linearization. The value is zero if the step lies within the trust 36759b94acceSBarry Smith region, and exceeds zero otherwise. 3676c7afd0dbSLois Curfman McInnes - ynorm - 2-norm of the step 36779b94acceSBarry Smith 36789b94acceSBarry Smith Note: 367904d7464bSBarry Smith For non-trust region methods such as SNESNEWTONLS, the parameter delta 36809b94acceSBarry Smith is set to be the maximum allowable step size. 36819b94acceSBarry Smith 36829b94acceSBarry Smith .keywords: SNES, nonlinear, scale, step 36839b94acceSBarry Smith */ 3684dfbe8321SBarry Smith PetscErrorCode SNESScaleStep_Private(SNES snes,Vec y,PetscReal *fnorm,PetscReal *delta,PetscReal *gpnorm,PetscReal *ynorm) 36859b94acceSBarry Smith { 3686064f8208SBarry Smith PetscReal nrm; 3687ea709b57SSatish Balay PetscScalar cnorm; 3688dfbe8321SBarry Smith PetscErrorCode ierr; 36893a40ed3dSBarry Smith 36903a40ed3dSBarry Smith PetscFunctionBegin; 36910700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 36920700a824SBarry Smith PetscValidHeaderSpecific(y,VEC_CLASSID,2); 3693c9780b6fSBarry Smith PetscCheckSameComm(snes,1,y,2); 3694184914b5SBarry Smith 3695064f8208SBarry Smith ierr = VecNorm(y,NORM_2,&nrm);CHKERRQ(ierr); 3696064f8208SBarry Smith if (nrm > *delta) { 3697064f8208SBarry Smith nrm = *delta/nrm; 3698064f8208SBarry Smith *gpnorm = (1.0 - nrm)*(*fnorm); 3699064f8208SBarry Smith cnorm = nrm; 37002dcb1b2aSMatthew Knepley ierr = VecScale(y,cnorm);CHKERRQ(ierr); 37019b94acceSBarry Smith *ynorm = *delta; 37029b94acceSBarry Smith } else { 37039b94acceSBarry Smith *gpnorm = 0.0; 3704064f8208SBarry Smith *ynorm = nrm; 37059b94acceSBarry Smith } 37063a40ed3dSBarry Smith PetscFunctionReturn(0); 37079b94acceSBarry Smith } 37089b94acceSBarry Smith 37094a2ae208SSatish Balay #undef __FUNCT__ 37104a2ae208SSatish Balay #define __FUNCT__ "SNESSolve" 37116ce558aeSBarry Smith /*@C 3712f69a0ea3SMatthew Knepley SNESSolve - Solves a nonlinear system F(x) = b. 3713f69a0ea3SMatthew Knepley Call SNESSolve() after calling SNESCreate() and optional routines of the form SNESSetXXX(). 37149b94acceSBarry Smith 3715c7afd0dbSLois Curfman McInnes Collective on SNES 3716c7afd0dbSLois Curfman McInnes 3717b2002411SLois Curfman McInnes Input Parameters: 3718c7afd0dbSLois Curfman McInnes + snes - the SNES context 37190298fd71SBarry Smith . b - the constant part of the equation F(x) = b, or NULL to use zero. 372085385478SLisandro Dalcin - x - the solution vector. 37219b94acceSBarry Smith 3722b2002411SLois Curfman McInnes Notes: 37238ddd3da0SLois Curfman McInnes The user should initialize the vector,x, with the initial guess 37248ddd3da0SLois Curfman McInnes for the nonlinear solve prior to calling SNESSolve. In particular, 37258ddd3da0SLois Curfman McInnes to employ an initial guess of zero, the user should explicitly set 37268ddd3da0SLois Curfman McInnes this vector to zero by calling VecSet(). 37278ddd3da0SLois Curfman McInnes 372836851e7fSLois Curfman McInnes Level: beginner 372936851e7fSLois Curfman McInnes 37309b94acceSBarry Smith .keywords: SNES, nonlinear, solve 37319b94acceSBarry Smith 3732c0df2a02SJed Brown .seealso: SNESCreate(), SNESDestroy(), SNESSetFunction(), SNESSetJacobian(), SNESSetGridSequence(), SNESGetSolution() 37339b94acceSBarry Smith @*/ 37347087cfbeSBarry Smith PetscErrorCode SNESSolve(SNES snes,Vec b,Vec x) 37359b94acceSBarry Smith { 3736dfbe8321SBarry Smith PetscErrorCode ierr; 3737ace3abfcSBarry Smith PetscBool flg; 3738eabae89aSBarry Smith PetscViewer viewer; 3739efd51863SBarry Smith PetscInt grid; 37400298fd71SBarry Smith Vec xcreated = NULL; 3741caa4e7f2SJed Brown DM dm; 3742cffb1e40SBarry Smith PetscViewerFormat format; 3743052efed2SBarry Smith 37443a40ed3dSBarry Smith PetscFunctionBegin; 37450700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 3746a69afd8bSBarry Smith if (x) PetscValidHeaderSpecific(x,VEC_CLASSID,3); 3747a69afd8bSBarry Smith if (x) PetscCheckSameComm(snes,1,x,3); 37480700a824SBarry Smith if (b) PetscValidHeaderSpecific(b,VEC_CLASSID,2); 374985385478SLisandro Dalcin if (b) PetscCheckSameComm(snes,1,b,2); 375085385478SLisandro Dalcin 3751caa4e7f2SJed Brown if (!x) { 3752caa4e7f2SJed Brown ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr); 3753caa4e7f2SJed Brown ierr = DMCreateGlobalVector(dm,&xcreated);CHKERRQ(ierr); 3754a69afd8bSBarry Smith x = xcreated; 3755a69afd8bSBarry Smith } 3756a69afd8bSBarry Smith 3757f05ece33SBarry Smith ierr = PetscOptionsGetViewer(PetscObjectComm((PetscObject)snes),((PetscObject)snes)->prefix,"-snes_view_pre",&viewer,&format,&flg);CHKERRQ(ierr); 3758f05ece33SBarry Smith if (flg && !PetscPreLoadingOn) { 3759f05ece33SBarry Smith ierr = PetscViewerPushFormat(viewer,format);CHKERRQ(ierr); 3760f05ece33SBarry Smith ierr = SNESView(snes,viewer);CHKERRQ(ierr); 3761f05ece33SBarry Smith ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr); 3762f05ece33SBarry Smith ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr); 3763f05ece33SBarry Smith } 3764f05ece33SBarry Smith 3765ce94432eSBarry Smith for (grid=0; grid<snes->gridsequence; grid++) {ierr = PetscViewerASCIIPushTab(PETSC_VIEWER_STDOUT_(PetscObjectComm((PetscObject)snes)));CHKERRQ(ierr);} 3766efd51863SBarry Smith for (grid=0; grid<snes->gridsequence+1; grid++) { 3767efd51863SBarry Smith 376885385478SLisandro Dalcin /* set solution vector */ 3769efd51863SBarry Smith if (!grid) {ierr = PetscObjectReference((PetscObject)x);CHKERRQ(ierr);} 37706bf464f9SBarry Smith ierr = VecDestroy(&snes->vec_sol);CHKERRQ(ierr); 377185385478SLisandro Dalcin snes->vec_sol = x; 3772caa4e7f2SJed Brown ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr); 3773caa4e7f2SJed Brown 3774caa4e7f2SJed Brown /* set affine vector if provided */ 377585385478SLisandro Dalcin if (b) { ierr = PetscObjectReference((PetscObject)b);CHKERRQ(ierr); } 37766bf464f9SBarry Smith ierr = VecDestroy(&snes->vec_rhs);CHKERRQ(ierr); 377785385478SLisandro Dalcin snes->vec_rhs = b; 377885385478SLisandro Dalcin 377970e92668SMatthew Knepley ierr = SNESSetUp(snes);CHKERRQ(ierr); 37803f149594SLisandro Dalcin 37817eee914bSBarry Smith if (!grid) { 37827eee914bSBarry Smith if (snes->ops->computeinitialguess) { 3783d25893d9SBarry Smith ierr = (*snes->ops->computeinitialguess)(snes,snes->vec_sol,snes->initialguessP);CHKERRQ(ierr); 3784d25893d9SBarry Smith } 3785dd568438SSatish Balay } 3786d25893d9SBarry Smith 3787abc0a331SBarry Smith if (snes->conv_hist_reset) snes->conv_hist_len = 0; 3788971e163fSPeter Brune if (snes->counters_reset) {snes->nfuncs = 0; snes->linear_its = 0; snes->numFailures = 0;} 3789d5e45103SBarry Smith 37903f149594SLisandro Dalcin ierr = PetscLogEventBegin(SNES_Solve,snes,0,0,0);CHKERRQ(ierr); 37914936397dSBarry Smith ierr = (*snes->ops->solve)(snes);CHKERRQ(ierr); 379285385478SLisandro Dalcin ierr = PetscLogEventEnd(SNES_Solve,snes,0,0,0);CHKERRQ(ierr); 37934936397dSBarry Smith if (snes->domainerror) { 37944936397dSBarry Smith snes->reason = SNES_DIVERGED_FUNCTION_DOMAIN; 37954936397dSBarry Smith snes->domainerror = PETSC_FALSE; 37964936397dSBarry Smith } 379717186662SBarry Smith if (!snes->reason) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_PLIB,"Internal error, solver returned without setting converged reason"); 37983f149594SLisandro Dalcin 379937ec4e1aSPeter Brune if (snes->lagjac_persist) snes->jac_iter += snes->iter; 380037ec4e1aSPeter Brune if (snes->lagpre_persist) snes->pre_iter += snes->iter; 380137ec4e1aSPeter Brune 380290d69ab7SBarry Smith flg = PETSC_FALSE; 38030298fd71SBarry Smith ierr = PetscOptionsGetBool(((PetscObject)snes)->prefix,"-snes_test_local_min",&flg,NULL);CHKERRQ(ierr); 3804da9b6338SBarry Smith if (flg && !PetscPreLoadingOn) { ierr = SNESTestLocalMin(snes);CHKERRQ(ierr); } 38055968eb51SBarry Smith if (snes->printreason) { 3806ce94432eSBarry Smith ierr = PetscViewerASCIIAddTab(PETSC_VIEWER_STDOUT_(PetscObjectComm((PetscObject)snes)),((PetscObject)snes)->tablevel);CHKERRQ(ierr); 38075968eb51SBarry Smith if (snes->reason > 0) { 3808ce94432eSBarry Smith ierr = PetscViewerASCIIPrintf(PETSC_VIEWER_STDOUT_(PetscObjectComm((PetscObject)snes)),"Nonlinear solve converged due to %s iterations %D\n",SNESConvergedReasons[snes->reason],snes->iter);CHKERRQ(ierr); 38095968eb51SBarry Smith } else { 3810ce94432eSBarry Smith ierr = PetscViewerASCIIPrintf(PETSC_VIEWER_STDOUT_(PetscObjectComm((PetscObject)snes)),"Nonlinear solve did not converge due to %s iterations %D\n",SNESConvergedReasons[snes->reason],snes->iter);CHKERRQ(ierr); 38115968eb51SBarry Smith } 3812ce94432eSBarry Smith ierr = PetscViewerASCIISubtractTab(PETSC_VIEWER_STDOUT_(PetscObjectComm((PetscObject)snes)),((PetscObject)snes)->tablevel);CHKERRQ(ierr); 38135968eb51SBarry Smith } 38145968eb51SBarry Smith 3815ce94432eSBarry Smith if (snes->errorifnotconverged && snes->reason < 0) SETERRQ(PetscObjectComm((PetscObject)snes),PETSC_ERR_NOT_CONVERGED,"SNESSolve has not converged"); 3816efd51863SBarry Smith if (grid < snes->gridsequence) { 3817efd51863SBarry Smith DM fine; 3818efd51863SBarry Smith Vec xnew; 3819efd51863SBarry Smith Mat interp; 3820efd51863SBarry Smith 3821ce94432eSBarry Smith ierr = DMRefine(snes->dm,PetscObjectComm((PetscObject)snes),&fine);CHKERRQ(ierr); 3822ce94432eSBarry Smith if (!fine) SETERRQ(PetscObjectComm((PetscObject)snes),PETSC_ERR_ARG_INCOMP,"DMRefine() did not perform any refinement, cannot continue grid sequencing"); 38230298fd71SBarry Smith ierr = DMCreateInterpolation(snes->dm,fine,&interp,NULL);CHKERRQ(ierr); 3824efd51863SBarry Smith ierr = DMCreateGlobalVector(fine,&xnew);CHKERRQ(ierr); 3825efd51863SBarry Smith ierr = MatInterpolate(interp,x,xnew);CHKERRQ(ierr); 3826c833c3b5SJed Brown ierr = DMInterpolate(snes->dm,interp,fine);CHKERRQ(ierr); 3827efd51863SBarry Smith ierr = MatDestroy(&interp);CHKERRQ(ierr); 3828efd51863SBarry Smith x = xnew; 3829efd51863SBarry Smith 3830efd51863SBarry Smith ierr = SNESReset(snes);CHKERRQ(ierr); 3831efd51863SBarry Smith ierr = SNESSetDM(snes,fine);CHKERRQ(ierr); 3832efd51863SBarry Smith ierr = DMDestroy(&fine);CHKERRQ(ierr); 3833ce94432eSBarry Smith ierr = PetscViewerASCIIPopTab(PETSC_VIEWER_STDOUT_(PetscObjectComm((PetscObject)snes)));CHKERRQ(ierr); 3834efd51863SBarry Smith } 3835efd51863SBarry Smith } 38363f7e2da0SPeter Brune /* monitoring and viewing */ 3837ce94432eSBarry Smith ierr = PetscOptionsGetViewer(PetscObjectComm((PetscObject)snes),((PetscObject)snes)->prefix,"-snes_view",&viewer,&format,&flg);CHKERRQ(ierr); 38383f7e2da0SPeter Brune if (flg && !PetscPreLoadingOn) { 3839cffb1e40SBarry Smith ierr = PetscViewerPushFormat(viewer,format);CHKERRQ(ierr); 38403f7e2da0SPeter Brune ierr = SNESView(snes,viewer);CHKERRQ(ierr); 3841cffb1e40SBarry Smith ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr); 3842cffb1e40SBarry Smith ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr); 384372a02f06SBarry Smith } 3844146574abSBarry Smith ierr = VecViewFromOptions(snes->vec_sol,((PetscObject)snes)->prefix,"-snes_view_solution");CHKERRQ(ierr); 38453f7e2da0SPeter Brune 3846a69afd8bSBarry Smith ierr = VecDestroy(&xcreated);CHKERRQ(ierr); 3847b90c6cbeSBarry Smith ierr = PetscObjectAMSBlock((PetscObject)snes);CHKERRQ(ierr); 38483a40ed3dSBarry Smith PetscFunctionReturn(0); 38499b94acceSBarry Smith } 38509b94acceSBarry Smith 38519b94acceSBarry Smith /* --------- Internal routines for SNES Package --------- */ 38529b94acceSBarry Smith 38534a2ae208SSatish Balay #undef __FUNCT__ 38544a2ae208SSatish Balay #define __FUNCT__ "SNESSetType" 385582bf6240SBarry Smith /*@C 38564b0e389bSBarry Smith SNESSetType - Sets the method for the nonlinear solver. 38579b94acceSBarry Smith 3858fee21e36SBarry Smith Collective on SNES 3859fee21e36SBarry Smith 3860c7afd0dbSLois Curfman McInnes Input Parameters: 3861c7afd0dbSLois Curfman McInnes + snes - the SNES context 3862454a90a3SBarry Smith - type - a known method 3863c7afd0dbSLois Curfman McInnes 3864c7afd0dbSLois Curfman McInnes Options Database Key: 3865454a90a3SBarry Smith . -snes_type <type> - Sets the method; use -help for a list 386604d7464bSBarry Smith of available methods (for instance, newtonls or newtontr) 3867ae12b187SLois Curfman McInnes 38689b94acceSBarry Smith Notes: 3869e090d566SSatish Balay See "petsc/include/petscsnes.h" for available methods (for instance) 387004d7464bSBarry Smith + SNESNEWTONLS - Newton's method with line search 3871c7afd0dbSLois Curfman McInnes (systems of nonlinear equations) 387204d7464bSBarry Smith . SNESNEWTONTR - Newton's method with trust region 3873c7afd0dbSLois Curfman McInnes (systems of nonlinear equations) 38749b94acceSBarry Smith 3875ae12b187SLois Curfman McInnes Normally, it is best to use the SNESSetFromOptions() command and then 3876ae12b187SLois Curfman McInnes set the SNES solver type from the options database rather than by using 3877ae12b187SLois Curfman McInnes this routine. Using the options database provides the user with 3878ae12b187SLois Curfman McInnes maximum flexibility in evaluating the many nonlinear solvers. 3879ae12b187SLois Curfman McInnes The SNESSetType() routine is provided for those situations where it 3880ae12b187SLois Curfman McInnes is necessary to set the nonlinear solver independently of the command 3881ae12b187SLois Curfman McInnes line or options database. This might be the case, for example, when 3882ae12b187SLois Curfman McInnes the choice of solver changes during the execution of the program, 3883ae12b187SLois Curfman McInnes and the user's application is taking responsibility for choosing the 3884b0a32e0cSBarry Smith appropriate method. 388536851e7fSLois Curfman McInnes 38868f6c3df8SBarry Smith Developer Notes: SNESRegister() adds a constructor for a new SNESType to SNESList, SNESSetType() locates 38878f6c3df8SBarry Smith the constructor in that list and calls it to create the spexific object. 38888f6c3df8SBarry Smith 388936851e7fSLois Curfman McInnes Level: intermediate 3890a703fe33SLois Curfman McInnes 3891454a90a3SBarry Smith .keywords: SNES, set, type 3892435da068SBarry Smith 38938f6c3df8SBarry Smith .seealso: SNESType, SNESCreate(), SNESDestroy(), SNESGetType(), SNESSetFromOptions() 3894435da068SBarry Smith 38959b94acceSBarry Smith @*/ 389619fd82e9SBarry Smith PetscErrorCode SNESSetType(SNES snes,SNESType type) 38979b94acceSBarry Smith { 3898dfbe8321SBarry Smith PetscErrorCode ierr,(*r)(SNES); 3899ace3abfcSBarry Smith PetscBool match; 39003a40ed3dSBarry Smith 39013a40ed3dSBarry Smith PetscFunctionBegin; 39020700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 39034482741eSBarry Smith PetscValidCharPointer(type,2); 390482bf6240SBarry Smith 3905251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)snes,type,&match);CHKERRQ(ierr); 39060f5bd95cSBarry Smith if (match) PetscFunctionReturn(0); 390792ff6ae8SBarry Smith 39081c9cd337SJed Brown ierr = PetscFunctionListFind(SNESList,type,&r);CHKERRQ(ierr); 3909e32f2f54SBarry Smith if (!r) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_UNKNOWN_TYPE,"Unable to find requested SNES type %s",type); 391075396ef9SLisandro Dalcin /* Destroy the previous private SNES context */ 3911b5c23020SJed Brown if (snes->ops->destroy) { 3912b5c23020SJed Brown ierr = (*(snes)->ops->destroy)(snes);CHKERRQ(ierr); 39130298fd71SBarry Smith snes->ops->destroy = NULL; 3914b5c23020SJed Brown } 391575396ef9SLisandro Dalcin /* Reinitialize function pointers in SNESOps structure */ 391675396ef9SLisandro Dalcin snes->ops->setup = 0; 391775396ef9SLisandro Dalcin snes->ops->solve = 0; 391875396ef9SLisandro Dalcin snes->ops->view = 0; 391975396ef9SLisandro Dalcin snes->ops->setfromoptions = 0; 392075396ef9SLisandro Dalcin snes->ops->destroy = 0; 392175396ef9SLisandro Dalcin /* Call the SNESCreate_XXX routine for this particular Nonlinear solver */ 392275396ef9SLisandro Dalcin snes->setupcalled = PETSC_FALSE; 3923f5af7f23SKarl Rupp 3924454a90a3SBarry Smith ierr = PetscObjectChangeTypeName((PetscObject)snes,type);CHKERRQ(ierr); 392503bfa161SLisandro Dalcin ierr = (*r)(snes);CHKERRQ(ierr); 39263a40ed3dSBarry Smith PetscFunctionReturn(0); 39279b94acceSBarry Smith } 39289b94acceSBarry Smith 39294a2ae208SSatish Balay #undef __FUNCT__ 39304a2ae208SSatish Balay #define __FUNCT__ "SNESGetType" 39319b94acceSBarry Smith /*@C 39329a28b0a6SLois Curfman McInnes SNESGetType - Gets the SNES method type and name (as a string). 39339b94acceSBarry Smith 3934c7afd0dbSLois Curfman McInnes Not Collective 3935c7afd0dbSLois Curfman McInnes 39369b94acceSBarry Smith Input Parameter: 39374b0e389bSBarry Smith . snes - nonlinear solver context 39389b94acceSBarry Smith 39399b94acceSBarry Smith Output Parameter: 39403a7fca6bSBarry Smith . type - SNES method (a character string) 39419b94acceSBarry Smith 394236851e7fSLois Curfman McInnes Level: intermediate 394336851e7fSLois Curfman McInnes 3944454a90a3SBarry Smith .keywords: SNES, nonlinear, get, type, name 39459b94acceSBarry Smith @*/ 394619fd82e9SBarry Smith PetscErrorCode SNESGetType(SNES snes,SNESType *type) 39479b94acceSBarry Smith { 39483a40ed3dSBarry Smith PetscFunctionBegin; 39490700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 39504482741eSBarry Smith PetscValidPointer(type,2); 39517adad957SLisandro Dalcin *type = ((PetscObject)snes)->type_name; 39523a40ed3dSBarry Smith PetscFunctionReturn(0); 39539b94acceSBarry Smith } 39549b94acceSBarry Smith 39554a2ae208SSatish Balay #undef __FUNCT__ 39564a2ae208SSatish Balay #define __FUNCT__ "SNESGetSolution" 395752baeb72SSatish Balay /*@ 39589b94acceSBarry Smith SNESGetSolution - Returns the vector where the approximate solution is 3959c0df2a02SJed Brown stored. This is the fine grid solution when using SNESSetGridSequence(). 39609b94acceSBarry Smith 3961c7afd0dbSLois Curfman McInnes Not Collective, but Vec is parallel if SNES is parallel 3962c7afd0dbSLois Curfman McInnes 39639b94acceSBarry Smith Input Parameter: 39649b94acceSBarry Smith . snes - the SNES context 39659b94acceSBarry Smith 39669b94acceSBarry Smith Output Parameter: 39679b94acceSBarry Smith . x - the solution 39689b94acceSBarry Smith 396970e92668SMatthew Knepley Level: intermediate 397036851e7fSLois Curfman McInnes 39719b94acceSBarry Smith .keywords: SNES, nonlinear, get, solution 39729b94acceSBarry Smith 397385385478SLisandro Dalcin .seealso: SNESGetSolutionUpdate(), SNESGetFunction() 39749b94acceSBarry Smith @*/ 39757087cfbeSBarry Smith PetscErrorCode SNESGetSolution(SNES snes,Vec *x) 39769b94acceSBarry Smith { 39773a40ed3dSBarry Smith PetscFunctionBegin; 39780700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 39794482741eSBarry Smith PetscValidPointer(x,2); 398085385478SLisandro Dalcin *x = snes->vec_sol; 398170e92668SMatthew Knepley PetscFunctionReturn(0); 398270e92668SMatthew Knepley } 398370e92668SMatthew Knepley 398470e92668SMatthew Knepley #undef __FUNCT__ 39854a2ae208SSatish Balay #define __FUNCT__ "SNESGetSolutionUpdate" 398652baeb72SSatish Balay /*@ 39879b94acceSBarry Smith SNESGetSolutionUpdate - Returns the vector where the solution update is 39889b94acceSBarry Smith stored. 39899b94acceSBarry Smith 3990c7afd0dbSLois Curfman McInnes Not Collective, but Vec is parallel if SNES is parallel 3991c7afd0dbSLois Curfman McInnes 39929b94acceSBarry Smith Input Parameter: 39939b94acceSBarry Smith . snes - the SNES context 39949b94acceSBarry Smith 39959b94acceSBarry Smith Output Parameter: 39969b94acceSBarry Smith . x - the solution update 39979b94acceSBarry Smith 399836851e7fSLois Curfman McInnes Level: advanced 399936851e7fSLois Curfman McInnes 40009b94acceSBarry Smith .keywords: SNES, nonlinear, get, solution, update 40019b94acceSBarry Smith 400285385478SLisandro Dalcin .seealso: SNESGetSolution(), SNESGetFunction() 40039b94acceSBarry Smith @*/ 40047087cfbeSBarry Smith PetscErrorCode SNESGetSolutionUpdate(SNES snes,Vec *x) 40059b94acceSBarry Smith { 40063a40ed3dSBarry Smith PetscFunctionBegin; 40070700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 40084482741eSBarry Smith PetscValidPointer(x,2); 400985385478SLisandro Dalcin *x = snes->vec_sol_update; 40103a40ed3dSBarry Smith PetscFunctionReturn(0); 40119b94acceSBarry Smith } 40129b94acceSBarry Smith 40134a2ae208SSatish Balay #undef __FUNCT__ 40144a2ae208SSatish Balay #define __FUNCT__ "SNESGetFunction" 40159b94acceSBarry Smith /*@C 40163638b69dSLois Curfman McInnes SNESGetFunction - Returns the vector where the function is stored. 40179b94acceSBarry Smith 4018a63bb30eSJed Brown Not Collective, but Vec is parallel if SNES is parallel. Collective if Vec is requested, but has not been created yet. 4019c7afd0dbSLois Curfman McInnes 40209b94acceSBarry Smith Input Parameter: 40219b94acceSBarry Smith . snes - the SNES context 40229b94acceSBarry Smith 40239b94acceSBarry Smith Output Parameter: 40240298fd71SBarry Smith + r - the vector that is used to store residuals (or NULL if you don't want it) 40250298fd71SBarry Smith . SNESFunction- the function (or NULL if you don't want it) 40260298fd71SBarry Smith - ctx - the function context (or NULL if you don't want it) 40279b94acceSBarry Smith 402836851e7fSLois Curfman McInnes Level: advanced 402936851e7fSLois Curfman McInnes 4030a86d99e1SLois Curfman McInnes .keywords: SNES, nonlinear, get, function 40319b94acceSBarry Smith 4032bf388a1fSBarry Smith .seealso: SNESSetFunction(), SNESGetSolution(), SNESFunction 40339b94acceSBarry Smith @*/ 4034bf388a1fSBarry Smith PetscErrorCode SNESGetFunction(SNES snes,Vec *r,PetscErrorCode (**SNESFunction)(SNES,Vec,Vec,void*),void **ctx) 40359b94acceSBarry Smith { 4036a63bb30eSJed Brown PetscErrorCode ierr; 40376cab3a1bSJed Brown DM dm; 4038a63bb30eSJed Brown 40393a40ed3dSBarry Smith PetscFunctionBegin; 40400700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 4041a63bb30eSJed Brown if (r) { 4042a63bb30eSJed Brown if (!snes->vec_func) { 4043a63bb30eSJed Brown if (snes->vec_rhs) { 4044a63bb30eSJed Brown ierr = VecDuplicate(snes->vec_rhs,&snes->vec_func);CHKERRQ(ierr); 4045a63bb30eSJed Brown } else if (snes->vec_sol) { 4046a63bb30eSJed Brown ierr = VecDuplicate(snes->vec_sol,&snes->vec_func);CHKERRQ(ierr); 4047a63bb30eSJed Brown } else if (snes->dm) { 4048a63bb30eSJed Brown ierr = DMCreateGlobalVector(snes->dm,&snes->vec_func);CHKERRQ(ierr); 4049a63bb30eSJed Brown } 4050a63bb30eSJed Brown } 4051a63bb30eSJed Brown *r = snes->vec_func; 4052a63bb30eSJed Brown } 40536cab3a1bSJed Brown ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr); 4054bf388a1fSBarry Smith ierr = DMSNESGetFunction(dm,SNESFunction,ctx);CHKERRQ(ierr); 40553a40ed3dSBarry Smith PetscFunctionReturn(0); 40569b94acceSBarry Smith } 40579b94acceSBarry Smith 4058c79ef259SPeter Brune /*@C 4059c79ef259SPeter Brune SNESGetGS - Returns the GS function and context. 4060c79ef259SPeter Brune 4061c79ef259SPeter Brune Input Parameter: 4062c79ef259SPeter Brune . snes - the SNES context 4063c79ef259SPeter Brune 4064c79ef259SPeter Brune Output Parameter: 40650298fd71SBarry Smith + SNESGSFunction - the function (or NULL) 40660298fd71SBarry Smith - ctx - the function context (or NULL) 4067c79ef259SPeter Brune 4068c79ef259SPeter Brune Level: advanced 4069c79ef259SPeter Brune 4070c79ef259SPeter Brune .keywords: SNES, nonlinear, get, function 4071c79ef259SPeter Brune 4072c79ef259SPeter Brune .seealso: SNESSetGS(), SNESGetFunction() 4073c79ef259SPeter Brune @*/ 4074c79ef259SPeter Brune 40754a2ae208SSatish Balay #undef __FUNCT__ 4076646217ecSPeter Brune #define __FUNCT__ "SNESGetGS" 4077bf388a1fSBarry Smith PetscErrorCode SNESGetGS (SNES snes, PetscErrorCode (**SNESGSFunction)(SNES, Vec, Vec, void*), void ** ctx) 4078646217ecSPeter Brune { 40796cab3a1bSJed Brown PetscErrorCode ierr; 40806cab3a1bSJed Brown DM dm; 40816cab3a1bSJed Brown 4082646217ecSPeter Brune PetscFunctionBegin; 4083646217ecSPeter Brune PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 40846cab3a1bSJed Brown ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr); 4085bf388a1fSBarry Smith ierr = DMSNESGetGS(dm,SNESGSFunction,ctx);CHKERRQ(ierr); 4086646217ecSPeter Brune PetscFunctionReturn(0); 4087646217ecSPeter Brune } 4088646217ecSPeter Brune 40894a2ae208SSatish Balay #undef __FUNCT__ 40904a2ae208SSatish Balay #define __FUNCT__ "SNESSetOptionsPrefix" 40913c7409f5SSatish Balay /*@C 40923c7409f5SSatish Balay SNESSetOptionsPrefix - Sets the prefix used for searching for all 4093d850072dSLois Curfman McInnes SNES options in the database. 40943c7409f5SSatish Balay 40953f9fe445SBarry Smith Logically Collective on SNES 4096fee21e36SBarry Smith 4097c7afd0dbSLois Curfman McInnes Input Parameter: 4098c7afd0dbSLois Curfman McInnes + snes - the SNES context 4099c7afd0dbSLois Curfman McInnes - prefix - the prefix to prepend to all option names 4100c7afd0dbSLois Curfman McInnes 4101d850072dSLois Curfman McInnes Notes: 4102a83b1b31SSatish Balay A hyphen (-) must NOT be given at the beginning of the prefix name. 4103c7afd0dbSLois Curfman McInnes The first character of all runtime options is AUTOMATICALLY the hyphen. 4104d850072dSLois Curfman McInnes 410536851e7fSLois Curfman McInnes Level: advanced 410636851e7fSLois Curfman McInnes 41073c7409f5SSatish Balay .keywords: SNES, set, options, prefix, database 4108a86d99e1SLois Curfman McInnes 4109a86d99e1SLois Curfman McInnes .seealso: SNESSetFromOptions() 41103c7409f5SSatish Balay @*/ 41117087cfbeSBarry Smith PetscErrorCode SNESSetOptionsPrefix(SNES snes,const char prefix[]) 41123c7409f5SSatish Balay { 4113dfbe8321SBarry Smith PetscErrorCode ierr; 41143c7409f5SSatish Balay 41153a40ed3dSBarry Smith PetscFunctionBegin; 41160700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 4117639f9d9dSBarry Smith ierr = PetscObjectSetOptionsPrefix((PetscObject)snes,prefix);CHKERRQ(ierr); 41181cee3971SBarry Smith if (!snes->ksp) {ierr = SNESGetKSP(snes,&snes->ksp);CHKERRQ(ierr);} 411935f5d045SPeter Brune if (snes->linesearch) { 41207601faf0SJed Brown ierr = SNESGetLineSearch(snes,&snes->linesearch);CHKERRQ(ierr); 412108b6c495SPeter Brune ierr = PetscObjectSetOptionsPrefix((PetscObject)snes->linesearch,prefix);CHKERRQ(ierr); 412235f5d045SPeter Brune } 412335f5d045SPeter Brune ierr = KSPSetOptionsPrefix(snes->ksp,prefix);CHKERRQ(ierr); 41243a40ed3dSBarry Smith PetscFunctionReturn(0); 41253c7409f5SSatish Balay } 41263c7409f5SSatish Balay 41274a2ae208SSatish Balay #undef __FUNCT__ 41284a2ae208SSatish Balay #define __FUNCT__ "SNESAppendOptionsPrefix" 41293c7409f5SSatish Balay /*@C 4130f525115eSLois Curfman McInnes SNESAppendOptionsPrefix - Appends to the prefix used for searching for all 4131d850072dSLois Curfman McInnes SNES options in the database. 41323c7409f5SSatish Balay 41333f9fe445SBarry Smith Logically Collective on SNES 4134fee21e36SBarry Smith 4135c7afd0dbSLois Curfman McInnes Input Parameters: 4136c7afd0dbSLois Curfman McInnes + snes - the SNES context 4137c7afd0dbSLois Curfman McInnes - prefix - the prefix to prepend to all option names 4138c7afd0dbSLois Curfman McInnes 4139d850072dSLois Curfman McInnes Notes: 4140a83b1b31SSatish Balay A hyphen (-) must NOT be given at the beginning of the prefix name. 4141c7afd0dbSLois Curfman McInnes The first character of all runtime options is AUTOMATICALLY the hyphen. 4142d850072dSLois Curfman McInnes 414336851e7fSLois Curfman McInnes Level: advanced 414436851e7fSLois Curfman McInnes 41453c7409f5SSatish Balay .keywords: SNES, append, options, prefix, database 4146a86d99e1SLois Curfman McInnes 4147a86d99e1SLois Curfman McInnes .seealso: SNESGetOptionsPrefix() 41483c7409f5SSatish Balay @*/ 41497087cfbeSBarry Smith PetscErrorCode SNESAppendOptionsPrefix(SNES snes,const char prefix[]) 41503c7409f5SSatish Balay { 4151dfbe8321SBarry Smith PetscErrorCode ierr; 41523c7409f5SSatish Balay 41533a40ed3dSBarry Smith PetscFunctionBegin; 41540700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 4155639f9d9dSBarry Smith ierr = PetscObjectAppendOptionsPrefix((PetscObject)snes,prefix);CHKERRQ(ierr); 41561cee3971SBarry Smith if (!snes->ksp) {ierr = SNESGetKSP(snes,&snes->ksp);CHKERRQ(ierr);} 415735f5d045SPeter Brune if (snes->linesearch) { 41587601faf0SJed Brown ierr = SNESGetLineSearch(snes,&snes->linesearch);CHKERRQ(ierr); 415908b6c495SPeter Brune ierr = PetscObjectAppendOptionsPrefix((PetscObject)snes->linesearch,prefix);CHKERRQ(ierr); 416035f5d045SPeter Brune } 416135f5d045SPeter Brune ierr = KSPAppendOptionsPrefix(snes->ksp,prefix);CHKERRQ(ierr); 41623a40ed3dSBarry Smith PetscFunctionReturn(0); 41633c7409f5SSatish Balay } 41643c7409f5SSatish Balay 41654a2ae208SSatish Balay #undef __FUNCT__ 41664a2ae208SSatish Balay #define __FUNCT__ "SNESGetOptionsPrefix" 41679ab63eb5SSatish Balay /*@C 41683c7409f5SSatish Balay SNESGetOptionsPrefix - Sets the prefix used for searching for all 41693c7409f5SSatish Balay SNES options in the database. 41703c7409f5SSatish Balay 4171c7afd0dbSLois Curfman McInnes Not Collective 4172c7afd0dbSLois Curfman McInnes 41733c7409f5SSatish Balay Input Parameter: 41743c7409f5SSatish Balay . snes - the SNES context 41753c7409f5SSatish Balay 41763c7409f5SSatish Balay Output Parameter: 41773c7409f5SSatish Balay . prefix - pointer to the prefix string used 41783c7409f5SSatish Balay 41794ef407dbSRichard Tran Mills Notes: On the fortran side, the user should pass in a string 'prefix' of 41809ab63eb5SSatish Balay sufficient length to hold the prefix. 41819ab63eb5SSatish Balay 418236851e7fSLois Curfman McInnes Level: advanced 418336851e7fSLois Curfman McInnes 41843c7409f5SSatish Balay .keywords: SNES, get, options, prefix, database 4185a86d99e1SLois Curfman McInnes 4186a86d99e1SLois Curfman McInnes .seealso: SNESAppendOptionsPrefix() 41873c7409f5SSatish Balay @*/ 41887087cfbeSBarry Smith PetscErrorCode SNESGetOptionsPrefix(SNES snes,const char *prefix[]) 41893c7409f5SSatish Balay { 4190dfbe8321SBarry Smith PetscErrorCode ierr; 41913c7409f5SSatish Balay 41923a40ed3dSBarry Smith PetscFunctionBegin; 41930700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 4194639f9d9dSBarry Smith ierr = PetscObjectGetOptionsPrefix((PetscObject)snes,prefix);CHKERRQ(ierr); 41953a40ed3dSBarry Smith PetscFunctionReturn(0); 41963c7409f5SSatish Balay } 41973c7409f5SSatish Balay 4198b2002411SLois Curfman McInnes 41994a2ae208SSatish Balay #undef __FUNCT__ 42004a2ae208SSatish Balay #define __FUNCT__ "SNESRegister" 42013cea93caSBarry Smith /*@C 42021c84c290SBarry Smith SNESRegister - Adds a method to the nonlinear solver package. 42031c84c290SBarry Smith 42041c84c290SBarry Smith Not collective 42051c84c290SBarry Smith 42061c84c290SBarry Smith Input Parameters: 42071c84c290SBarry Smith + name_solver - name of a new user-defined solver 42081c84c290SBarry Smith - routine_create - routine to create method context 42091c84c290SBarry Smith 42101c84c290SBarry Smith Notes: 42111c84c290SBarry Smith SNESRegister() may be called multiple times to add several user-defined solvers. 42121c84c290SBarry Smith 42131c84c290SBarry Smith Sample usage: 42141c84c290SBarry Smith .vb 4215bdf89e91SBarry Smith SNESRegister("my_solver",MySolverCreate); 42161c84c290SBarry Smith .ve 42171c84c290SBarry Smith 42181c84c290SBarry Smith Then, your solver can be chosen with the procedural interface via 42191c84c290SBarry Smith $ SNESSetType(snes,"my_solver") 42201c84c290SBarry Smith or at runtime via the option 42211c84c290SBarry Smith $ -snes_type my_solver 42221c84c290SBarry Smith 42231c84c290SBarry Smith Level: advanced 42241c84c290SBarry Smith 42251c84c290SBarry Smith Note: If your function is not being put into a shared library then use SNESRegister() instead 42261c84c290SBarry Smith 42271c84c290SBarry Smith .keywords: SNES, nonlinear, register 42281c84c290SBarry Smith 42291c84c290SBarry Smith .seealso: SNESRegisterAll(), SNESRegisterDestroy() 42303cea93caSBarry Smith 42317f6c08e0SMatthew Knepley Level: advanced 42323cea93caSBarry Smith @*/ 4233bdf89e91SBarry Smith PetscErrorCode SNESRegister(const char sname[],PetscErrorCode (*function)(SNES)) 4234b2002411SLois Curfman McInnes { 4235dfbe8321SBarry Smith PetscErrorCode ierr; 4236b2002411SLois Curfman McInnes 4237b2002411SLois Curfman McInnes PetscFunctionBegin; 4238a240a19fSJed Brown ierr = PetscFunctionListAdd(&SNESList,sname,function);CHKERRQ(ierr); 4239b2002411SLois Curfman McInnes PetscFunctionReturn(0); 4240b2002411SLois Curfman McInnes } 4241da9b6338SBarry Smith 4242da9b6338SBarry Smith #undef __FUNCT__ 4243da9b6338SBarry Smith #define __FUNCT__ "SNESTestLocalMin" 42447087cfbeSBarry Smith PetscErrorCode SNESTestLocalMin(SNES snes) 4245da9b6338SBarry Smith { 4246dfbe8321SBarry Smith PetscErrorCode ierr; 424777431f27SBarry Smith PetscInt N,i,j; 4248da9b6338SBarry Smith Vec u,uh,fh; 4249da9b6338SBarry Smith PetscScalar value; 4250da9b6338SBarry Smith PetscReal norm; 4251da9b6338SBarry Smith 4252da9b6338SBarry Smith PetscFunctionBegin; 4253da9b6338SBarry Smith ierr = SNESGetSolution(snes,&u);CHKERRQ(ierr); 4254da9b6338SBarry Smith ierr = VecDuplicate(u,&uh);CHKERRQ(ierr); 4255da9b6338SBarry Smith ierr = VecDuplicate(u,&fh);CHKERRQ(ierr); 4256da9b6338SBarry Smith 4257da9b6338SBarry Smith /* currently only works for sequential */ 425822d28d08SBarry Smith ierr = PetscPrintf(PETSC_COMM_WORLD,"Testing FormFunction() for local min\n");CHKERRQ(ierr); 4259da9b6338SBarry Smith ierr = VecGetSize(u,&N);CHKERRQ(ierr); 4260da9b6338SBarry Smith for (i=0; i<N; i++) { 4261da9b6338SBarry Smith ierr = VecCopy(u,uh);CHKERRQ(ierr); 426277431f27SBarry Smith ierr = PetscPrintf(PETSC_COMM_WORLD,"i = %D\n",i);CHKERRQ(ierr); 4263da9b6338SBarry Smith for (j=-10; j<11; j++) { 4264ccae9161SBarry Smith value = PetscSign(j)*exp(PetscAbs(j)-10.0); 4265da9b6338SBarry Smith ierr = VecSetValue(uh,i,value,ADD_VALUES);CHKERRQ(ierr); 42663ab0aad5SBarry Smith ierr = SNESComputeFunction(snes,uh,fh);CHKERRQ(ierr); 4267da9b6338SBarry Smith ierr = VecNorm(fh,NORM_2,&norm);CHKERRQ(ierr); 426877431f27SBarry Smith ierr = PetscPrintf(PETSC_COMM_WORLD," j norm %D %18.16e\n",j,norm);CHKERRQ(ierr); 4269da9b6338SBarry Smith value = -value; 4270da9b6338SBarry Smith ierr = VecSetValue(uh,i,value,ADD_VALUES);CHKERRQ(ierr); 4271da9b6338SBarry Smith } 4272da9b6338SBarry Smith } 42736bf464f9SBarry Smith ierr = VecDestroy(&uh);CHKERRQ(ierr); 42746bf464f9SBarry Smith ierr = VecDestroy(&fh);CHKERRQ(ierr); 4275da9b6338SBarry Smith PetscFunctionReturn(0); 4276da9b6338SBarry Smith } 427771f87433Sdalcinl 427871f87433Sdalcinl #undef __FUNCT__ 4279fa9f3622SBarry Smith #define __FUNCT__ "SNESKSPSetUseEW" 428071f87433Sdalcinl /*@ 4281fa9f3622SBarry Smith SNESKSPSetUseEW - Sets SNES use Eisenstat-Walker method for 428271f87433Sdalcinl computing relative tolerance for linear solvers within an inexact 428371f87433Sdalcinl Newton method. 428471f87433Sdalcinl 42853f9fe445SBarry Smith Logically Collective on SNES 428671f87433Sdalcinl 428771f87433Sdalcinl Input Parameters: 428871f87433Sdalcinl + snes - SNES context 428971f87433Sdalcinl - flag - PETSC_TRUE or PETSC_FALSE 429071f87433Sdalcinl 429164ba62caSBarry Smith Options Database: 429264ba62caSBarry Smith + -snes_ksp_ew - use Eisenstat-Walker method for determining linear system convergence 429364ba62caSBarry Smith . -snes_ksp_ew_version ver - version of Eisenstat-Walker method 429464ba62caSBarry Smith . -snes_ksp_ew_rtol0 <rtol0> - Sets rtol0 429564ba62caSBarry Smith . -snes_ksp_ew_rtolmax <rtolmax> - Sets rtolmax 429664ba62caSBarry Smith . -snes_ksp_ew_gamma <gamma> - Sets gamma 429764ba62caSBarry Smith . -snes_ksp_ew_alpha <alpha> - Sets alpha 429864ba62caSBarry Smith . -snes_ksp_ew_alpha2 <alpha2> - Sets alpha2 429964ba62caSBarry Smith - -snes_ksp_ew_threshold <threshold> - Sets threshold 430064ba62caSBarry Smith 430171f87433Sdalcinl Notes: 430271f87433Sdalcinl Currently, the default is to use a constant relative tolerance for 430371f87433Sdalcinl the inner linear solvers. Alternatively, one can use the 430471f87433Sdalcinl Eisenstat-Walker method, where the relative convergence tolerance 430571f87433Sdalcinl is reset at each Newton iteration according progress of the nonlinear 430671f87433Sdalcinl solver. 430771f87433Sdalcinl 430871f87433Sdalcinl Level: advanced 430971f87433Sdalcinl 431071f87433Sdalcinl Reference: 431171f87433Sdalcinl S. C. Eisenstat and H. F. Walker, "Choosing the forcing terms in an 431271f87433Sdalcinl inexact Newton method", SISC 17 (1), pp.16-32, 1996. 431371f87433Sdalcinl 431471f87433Sdalcinl .keywords: SNES, KSP, Eisenstat, Walker, convergence, test, inexact, Newton 431571f87433Sdalcinl 4316fa9f3622SBarry Smith .seealso: SNESKSPGetUseEW(), SNESKSPGetParametersEW(), SNESKSPSetParametersEW() 431771f87433Sdalcinl @*/ 43187087cfbeSBarry Smith PetscErrorCode SNESKSPSetUseEW(SNES snes,PetscBool flag) 431971f87433Sdalcinl { 432071f87433Sdalcinl PetscFunctionBegin; 43210700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 4322acfcf0e5SJed Brown PetscValidLogicalCollectiveBool(snes,flag,2); 432371f87433Sdalcinl snes->ksp_ewconv = flag; 432471f87433Sdalcinl PetscFunctionReturn(0); 432571f87433Sdalcinl } 432671f87433Sdalcinl 432771f87433Sdalcinl #undef __FUNCT__ 4328fa9f3622SBarry Smith #define __FUNCT__ "SNESKSPGetUseEW" 432971f87433Sdalcinl /*@ 4330fa9f3622SBarry Smith SNESKSPGetUseEW - Gets if SNES is using Eisenstat-Walker method 433171f87433Sdalcinl for computing relative tolerance for linear solvers within an 433271f87433Sdalcinl inexact Newton method. 433371f87433Sdalcinl 433471f87433Sdalcinl Not Collective 433571f87433Sdalcinl 433671f87433Sdalcinl Input Parameter: 433771f87433Sdalcinl . snes - SNES context 433871f87433Sdalcinl 433971f87433Sdalcinl Output Parameter: 434071f87433Sdalcinl . flag - PETSC_TRUE or PETSC_FALSE 434171f87433Sdalcinl 434271f87433Sdalcinl Notes: 434371f87433Sdalcinl Currently, the default is to use a constant relative tolerance for 434471f87433Sdalcinl the inner linear solvers. Alternatively, one can use the 434571f87433Sdalcinl Eisenstat-Walker method, where the relative convergence tolerance 434671f87433Sdalcinl is reset at each Newton iteration according progress of the nonlinear 434771f87433Sdalcinl solver. 434871f87433Sdalcinl 434971f87433Sdalcinl Level: advanced 435071f87433Sdalcinl 435171f87433Sdalcinl Reference: 435271f87433Sdalcinl S. C. Eisenstat and H. F. Walker, "Choosing the forcing terms in an 435371f87433Sdalcinl inexact Newton method", SISC 17 (1), pp.16-32, 1996. 435471f87433Sdalcinl 435571f87433Sdalcinl .keywords: SNES, KSP, Eisenstat, Walker, convergence, test, inexact, Newton 435671f87433Sdalcinl 4357fa9f3622SBarry Smith .seealso: SNESKSPSetUseEW(), SNESKSPGetParametersEW(), SNESKSPSetParametersEW() 435871f87433Sdalcinl @*/ 43597087cfbeSBarry Smith PetscErrorCode SNESKSPGetUseEW(SNES snes, PetscBool *flag) 436071f87433Sdalcinl { 436171f87433Sdalcinl PetscFunctionBegin; 43620700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 436371f87433Sdalcinl PetscValidPointer(flag,2); 436471f87433Sdalcinl *flag = snes->ksp_ewconv; 436571f87433Sdalcinl PetscFunctionReturn(0); 436671f87433Sdalcinl } 436771f87433Sdalcinl 436871f87433Sdalcinl #undef __FUNCT__ 4369fa9f3622SBarry Smith #define __FUNCT__ "SNESKSPSetParametersEW" 437071f87433Sdalcinl /*@ 4371fa9f3622SBarry Smith SNESKSPSetParametersEW - Sets parameters for Eisenstat-Walker 437271f87433Sdalcinl convergence criteria for the linear solvers within an inexact 437371f87433Sdalcinl Newton method. 437471f87433Sdalcinl 43753f9fe445SBarry Smith Logically Collective on SNES 437671f87433Sdalcinl 437771f87433Sdalcinl Input Parameters: 437871f87433Sdalcinl + snes - SNES context 437971f87433Sdalcinl . version - version 1, 2 (default is 2) or 3 438071f87433Sdalcinl . rtol_0 - initial relative tolerance (0 <= rtol_0 < 1) 438171f87433Sdalcinl . rtol_max - maximum relative tolerance (0 <= rtol_max < 1) 438271f87433Sdalcinl . gamma - multiplicative factor for version 2 rtol computation 438371f87433Sdalcinl (0 <= gamma2 <= 1) 438471f87433Sdalcinl . alpha - power for version 2 rtol computation (1 < alpha <= 2) 438571f87433Sdalcinl . alpha2 - power for safeguard 438671f87433Sdalcinl - threshold - threshold for imposing safeguard (0 < threshold < 1) 438771f87433Sdalcinl 438871f87433Sdalcinl Note: 438971f87433Sdalcinl Version 3 was contributed by Luis Chacon, June 2006. 439071f87433Sdalcinl 439171f87433Sdalcinl Use PETSC_DEFAULT to retain the default for any of the parameters. 439271f87433Sdalcinl 439371f87433Sdalcinl Level: advanced 439471f87433Sdalcinl 439571f87433Sdalcinl Reference: 439671f87433Sdalcinl S. C. Eisenstat and H. F. Walker, "Choosing the forcing terms in an 439771f87433Sdalcinl inexact Newton method", Utah State University Math. Stat. Dept. Res. 439871f87433Sdalcinl Report 6/94/75, June, 1994, to appear in SIAM J. Sci. Comput. 439971f87433Sdalcinl 440071f87433Sdalcinl .keywords: SNES, KSP, Eisenstat, Walker, set, parameters 440171f87433Sdalcinl 4402fa9f3622SBarry Smith .seealso: SNESKSPSetUseEW(), SNESKSPGetUseEW(), SNESKSPGetParametersEW() 440371f87433Sdalcinl @*/ 4404f5af7f23SKarl Rupp PetscErrorCode SNESKSPSetParametersEW(SNES snes,PetscInt version,PetscReal rtol_0,PetscReal rtol_max,PetscReal gamma,PetscReal alpha,PetscReal alpha2,PetscReal threshold) 440571f87433Sdalcinl { 4406fa9f3622SBarry Smith SNESKSPEW *kctx; 44075fd66863SKarl Rupp 440871f87433Sdalcinl PetscFunctionBegin; 44090700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 4410fa9f3622SBarry Smith kctx = (SNESKSPEW*)snes->kspconvctx; 4411e32f2f54SBarry Smith if (!kctx) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"No Eisenstat-Walker context existing"); 4412c5eb9154SBarry Smith PetscValidLogicalCollectiveInt(snes,version,2); 4413c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(snes,rtol_0,3); 4414c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(snes,rtol_max,4); 4415c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(snes,gamma,5); 4416c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(snes,alpha,6); 4417c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(snes,alpha2,7); 4418c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(snes,threshold,8); 441971f87433Sdalcinl 442071f87433Sdalcinl if (version != PETSC_DEFAULT) kctx->version = version; 442171f87433Sdalcinl if (rtol_0 != PETSC_DEFAULT) kctx->rtol_0 = rtol_0; 442271f87433Sdalcinl if (rtol_max != PETSC_DEFAULT) kctx->rtol_max = rtol_max; 442371f87433Sdalcinl if (gamma != PETSC_DEFAULT) kctx->gamma = gamma; 442471f87433Sdalcinl if (alpha != PETSC_DEFAULT) kctx->alpha = alpha; 442571f87433Sdalcinl if (alpha2 != PETSC_DEFAULT) kctx->alpha2 = alpha2; 442671f87433Sdalcinl if (threshold != PETSC_DEFAULT) kctx->threshold = threshold; 442771f87433Sdalcinl 4428f23aa3ddSBarry Smith if (kctx->version < 1 || kctx->version > 3) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Only versions 1, 2 and 3 are supported: %D",kctx->version); 4429f23aa3ddSBarry Smith if (kctx->rtol_0 < 0.0 || kctx->rtol_0 >= 1.0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"0.0 <= rtol_0 < 1.0: %G",kctx->rtol_0); 4430f23aa3ddSBarry Smith if (kctx->rtol_max < 0.0 || kctx->rtol_max >= 1.0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"0.0 <= rtol_max (%G) < 1.0\n",kctx->rtol_max); 4431f23aa3ddSBarry Smith if (kctx->gamma < 0.0 || kctx->gamma > 1.0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"0.0 <= gamma (%G) <= 1.0\n",kctx->gamma); 4432f23aa3ddSBarry Smith if (kctx->alpha <= 1.0 || kctx->alpha > 2.0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"1.0 < alpha (%G) <= 2.0\n",kctx->alpha); 4433f23aa3ddSBarry Smith if (kctx->threshold <= 0.0 || kctx->threshold >= 1.0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"0.0 < threshold (%G) < 1.0\n",kctx->threshold); 443471f87433Sdalcinl PetscFunctionReturn(0); 443571f87433Sdalcinl } 443671f87433Sdalcinl 443771f87433Sdalcinl #undef __FUNCT__ 4438fa9f3622SBarry Smith #define __FUNCT__ "SNESKSPGetParametersEW" 443971f87433Sdalcinl /*@ 4440fa9f3622SBarry Smith SNESKSPGetParametersEW - Gets parameters for Eisenstat-Walker 444171f87433Sdalcinl convergence criteria for the linear solvers within an inexact 444271f87433Sdalcinl Newton method. 444371f87433Sdalcinl 444471f87433Sdalcinl Not Collective 444571f87433Sdalcinl 444671f87433Sdalcinl Input Parameters: 444771f87433Sdalcinl snes - SNES context 444871f87433Sdalcinl 444971f87433Sdalcinl Output Parameters: 445071f87433Sdalcinl + version - version 1, 2 (default is 2) or 3 445171f87433Sdalcinl . rtol_0 - initial relative tolerance (0 <= rtol_0 < 1) 445271f87433Sdalcinl . rtol_max - maximum relative tolerance (0 <= rtol_max < 1) 4453bf388a1fSBarry Smith . gamma - multiplicative factor for version 2 rtol computation (0 <= gamma2 <= 1) 445471f87433Sdalcinl . alpha - power for version 2 rtol computation (1 < alpha <= 2) 445571f87433Sdalcinl . alpha2 - power for safeguard 445671f87433Sdalcinl - threshold - threshold for imposing safeguard (0 < threshold < 1) 445771f87433Sdalcinl 445871f87433Sdalcinl Level: advanced 445971f87433Sdalcinl 446071f87433Sdalcinl .keywords: SNES, KSP, Eisenstat, Walker, get, parameters 446171f87433Sdalcinl 4462fa9f3622SBarry Smith .seealso: SNESKSPSetUseEW(), SNESKSPGetUseEW(), SNESKSPSetParametersEW() 446371f87433Sdalcinl @*/ 4464bf388a1fSBarry Smith PetscErrorCode SNESKSPGetParametersEW(SNES snes,PetscInt *version,PetscReal *rtol_0,PetscReal *rtol_max,PetscReal *gamma,PetscReal *alpha,PetscReal *alpha2,PetscReal *threshold) 446571f87433Sdalcinl { 4466fa9f3622SBarry Smith SNESKSPEW *kctx; 44675fd66863SKarl Rupp 446871f87433Sdalcinl PetscFunctionBegin; 44690700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 4470fa9f3622SBarry Smith kctx = (SNESKSPEW*)snes->kspconvctx; 4471e32f2f54SBarry Smith if (!kctx) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"No Eisenstat-Walker context existing"); 447271f87433Sdalcinl if (version) *version = kctx->version; 447371f87433Sdalcinl if (rtol_0) *rtol_0 = kctx->rtol_0; 447471f87433Sdalcinl if (rtol_max) *rtol_max = kctx->rtol_max; 447571f87433Sdalcinl if (gamma) *gamma = kctx->gamma; 447671f87433Sdalcinl if (alpha) *alpha = kctx->alpha; 447771f87433Sdalcinl if (alpha2) *alpha2 = kctx->alpha2; 447871f87433Sdalcinl if (threshold) *threshold = kctx->threshold; 447971f87433Sdalcinl PetscFunctionReturn(0); 448071f87433Sdalcinl } 448171f87433Sdalcinl 448271f87433Sdalcinl #undef __FUNCT__ 4483fa9f3622SBarry Smith #define __FUNCT__ "SNESKSPEW_PreSolve" 4484d4211eb9SBarry Smith PetscErrorCode SNESKSPEW_PreSolve(KSP ksp, Vec b, Vec x, SNES snes) 448571f87433Sdalcinl { 448671f87433Sdalcinl PetscErrorCode ierr; 4487fa9f3622SBarry Smith SNESKSPEW *kctx = (SNESKSPEW*)snes->kspconvctx; 448871f87433Sdalcinl PetscReal rtol = PETSC_DEFAULT,stol; 448971f87433Sdalcinl 449071f87433Sdalcinl PetscFunctionBegin; 4491d4211eb9SBarry Smith if (!snes->ksp_ewconv) PetscFunctionReturn(0); 4492f5af7f23SKarl Rupp if (!snes->iter) rtol = kctx->rtol_0; /* first time in, so use the original user rtol */ 4493f5af7f23SKarl Rupp else { 449471f87433Sdalcinl if (kctx->version == 1) { 449571f87433Sdalcinl rtol = (snes->norm - kctx->lresid_last)/kctx->norm_last; 449671f87433Sdalcinl if (rtol < 0.0) rtol = -rtol; 449785ec1a3cSBarry Smith stol = PetscPowReal(kctx->rtol_last,kctx->alpha2); 449871f87433Sdalcinl if (stol > kctx->threshold) rtol = PetscMax(rtol,stol); 449971f87433Sdalcinl } else if (kctx->version == 2) { 450085ec1a3cSBarry Smith rtol = kctx->gamma * PetscPowReal(snes->norm/kctx->norm_last,kctx->alpha); 450185ec1a3cSBarry Smith stol = kctx->gamma * PetscPowReal(kctx->rtol_last,kctx->alpha); 450271f87433Sdalcinl if (stol > kctx->threshold) rtol = PetscMax(rtol,stol); 450371f87433Sdalcinl } else if (kctx->version == 3) { /* contributed by Luis Chacon, June 2006. */ 450485ec1a3cSBarry Smith rtol = kctx->gamma * PetscPowReal(snes->norm/kctx->norm_last,kctx->alpha); 450571f87433Sdalcinl /* safeguard: avoid sharp decrease of rtol */ 450685ec1a3cSBarry Smith stol = kctx->gamma*PetscPowReal(kctx->rtol_last,kctx->alpha); 450771f87433Sdalcinl stol = PetscMax(rtol,stol); 450871f87433Sdalcinl rtol = PetscMin(kctx->rtol_0,stol); 450971f87433Sdalcinl /* safeguard: avoid oversolving */ 451071f87433Sdalcinl stol = kctx->gamma*(snes->ttol)/snes->norm; 451171f87433Sdalcinl stol = PetscMax(rtol,stol); 451271f87433Sdalcinl rtol = PetscMin(kctx->rtol_0,stol); 4513e32f2f54SBarry Smith } else SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Only versions 1, 2 or 3 are supported: %D",kctx->version); 451471f87433Sdalcinl } 451571f87433Sdalcinl /* safeguard: avoid rtol greater than one */ 451671f87433Sdalcinl rtol = PetscMin(rtol,kctx->rtol_max); 451771f87433Sdalcinl ierr = KSPSetTolerances(ksp,rtol,PETSC_DEFAULT,PETSC_DEFAULT,PETSC_DEFAULT);CHKERRQ(ierr); 451871f87433Sdalcinl ierr = PetscInfo3(snes,"iter %D, Eisenstat-Walker (version %D) KSP rtol=%G\n",snes->iter,kctx->version,rtol);CHKERRQ(ierr); 451971f87433Sdalcinl PetscFunctionReturn(0); 452071f87433Sdalcinl } 452171f87433Sdalcinl 452271f87433Sdalcinl #undef __FUNCT__ 4523fa9f3622SBarry Smith #define __FUNCT__ "SNESKSPEW_PostSolve" 4524d4211eb9SBarry Smith PetscErrorCode SNESKSPEW_PostSolve(KSP ksp, Vec b, Vec x, SNES snes) 452571f87433Sdalcinl { 452671f87433Sdalcinl PetscErrorCode ierr; 4527fa9f3622SBarry Smith SNESKSPEW *kctx = (SNESKSPEW*)snes->kspconvctx; 452871f87433Sdalcinl PCSide pcside; 452971f87433Sdalcinl Vec lres; 453071f87433Sdalcinl 453171f87433Sdalcinl PetscFunctionBegin; 4532d4211eb9SBarry Smith if (!snes->ksp_ewconv) PetscFunctionReturn(0); 453371f87433Sdalcinl ierr = KSPGetTolerances(ksp,&kctx->rtol_last,0,0,0);CHKERRQ(ierr); 453471f87433Sdalcinl ierr = SNESGetFunctionNorm(snes,&kctx->norm_last);CHKERRQ(ierr); 453571f87433Sdalcinl if (kctx->version == 1) { 4536b037da10SBarry Smith ierr = KSPGetPCSide(ksp,&pcside);CHKERRQ(ierr); 453771f87433Sdalcinl if (pcside == PC_RIGHT) { /* XXX Should we also test KSP_UNPRECONDITIONED_NORM ? */ 453871f87433Sdalcinl /* KSP residual is true linear residual */ 453971f87433Sdalcinl ierr = KSPGetResidualNorm(ksp,&kctx->lresid_last);CHKERRQ(ierr); 454071f87433Sdalcinl } else { 454171f87433Sdalcinl /* KSP residual is preconditioned residual */ 454271f87433Sdalcinl /* compute true linear residual norm */ 454371f87433Sdalcinl ierr = VecDuplicate(b,&lres);CHKERRQ(ierr); 454471f87433Sdalcinl ierr = MatMult(snes->jacobian,x,lres);CHKERRQ(ierr); 454571f87433Sdalcinl ierr = VecAYPX(lres,-1.0,b);CHKERRQ(ierr); 454671f87433Sdalcinl ierr = VecNorm(lres,NORM_2,&kctx->lresid_last);CHKERRQ(ierr); 45476bf464f9SBarry Smith ierr = VecDestroy(&lres);CHKERRQ(ierr); 454871f87433Sdalcinl } 454971f87433Sdalcinl } 455071f87433Sdalcinl PetscFunctionReturn(0); 455171f87433Sdalcinl } 455271f87433Sdalcinl 455371f87433Sdalcinl #undef __FUNCT__ 4554d4211eb9SBarry Smith #define __FUNCT__ "SNESGetKSP" 4555d4211eb9SBarry Smith /*@ 4556d4211eb9SBarry Smith SNESGetKSP - Returns the KSP context for a SNES solver. 4557d4211eb9SBarry Smith 4558d4211eb9SBarry Smith Not Collective, but if SNES object is parallel, then KSP object is parallel 4559d4211eb9SBarry Smith 4560d4211eb9SBarry Smith Input Parameter: 4561d4211eb9SBarry Smith . snes - the SNES context 4562d4211eb9SBarry Smith 4563d4211eb9SBarry Smith Output Parameter: 4564d4211eb9SBarry Smith . ksp - the KSP context 4565d4211eb9SBarry Smith 4566d4211eb9SBarry Smith Notes: 4567d4211eb9SBarry Smith The user can then directly manipulate the KSP context to set various 4568d4211eb9SBarry Smith options, etc. Likewise, the user can then extract and manipulate the 4569d4211eb9SBarry Smith PC contexts as well. 4570d4211eb9SBarry Smith 4571d4211eb9SBarry Smith Level: beginner 4572d4211eb9SBarry Smith 4573d4211eb9SBarry Smith .keywords: SNES, nonlinear, get, KSP, context 4574d4211eb9SBarry Smith 4575d4211eb9SBarry Smith .seealso: KSPGetPC(), SNESCreate(), KSPCreate(), SNESSetKSP() 4576d4211eb9SBarry Smith @*/ 4577d4211eb9SBarry Smith PetscErrorCode SNESGetKSP(SNES snes,KSP *ksp) 457871f87433Sdalcinl { 457971f87433Sdalcinl PetscErrorCode ierr; 458071f87433Sdalcinl 458171f87433Sdalcinl PetscFunctionBegin; 4582d4211eb9SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 4583d4211eb9SBarry Smith PetscValidPointer(ksp,2); 4584d4211eb9SBarry Smith 4585d4211eb9SBarry Smith if (!snes->ksp) { 4586d4211eb9SBarry Smith ierr = KSPCreate(PetscObjectComm((PetscObject)snes),&snes->ksp);CHKERRQ(ierr); 4587d4211eb9SBarry Smith ierr = PetscObjectIncrementTabLevel((PetscObject)snes->ksp,(PetscObject)snes,1);CHKERRQ(ierr); 45883bb1ff40SBarry Smith ierr = PetscLogObjectParent((PetscObject)snes,(PetscObject)snes->ksp);CHKERRQ(ierr); 4589d4211eb9SBarry Smith 4590d4211eb9SBarry Smith ierr = KSPSetPreSolve(snes->ksp,(PetscErrorCode (*)(KSP,Vec,Vec,void*))SNESKSPEW_PreSolve,snes);CHKERRQ(ierr); 4591d4211eb9SBarry Smith ierr = KSPSetPostSolve(snes->ksp,(PetscErrorCode (*)(KSP,Vec,Vec,void*))SNESKSPEW_PostSolve,snes);CHKERRQ(ierr); 4592d4211eb9SBarry Smith } 4593d4211eb9SBarry Smith *ksp = snes->ksp; 459471f87433Sdalcinl PetscFunctionReturn(0); 459571f87433Sdalcinl } 45966c699258SBarry Smith 4597d4211eb9SBarry Smith 4598b4615a05SBarry Smith #include <petsc-private/dmimpl.h> 45996c699258SBarry Smith #undef __FUNCT__ 46006c699258SBarry Smith #define __FUNCT__ "SNESSetDM" 46016c699258SBarry Smith /*@ 46026c699258SBarry Smith SNESSetDM - Sets the DM that may be used by some preconditioners 46036c699258SBarry Smith 46043f9fe445SBarry Smith Logically Collective on SNES 46056c699258SBarry Smith 46066c699258SBarry Smith Input Parameters: 46076c699258SBarry Smith + snes - the preconditioner context 46086c699258SBarry Smith - dm - the dm 46096c699258SBarry Smith 46106c699258SBarry Smith Level: intermediate 46116c699258SBarry Smith 46126c699258SBarry Smith .seealso: SNESGetDM(), KSPSetDM(), KSPGetDM() 46136c699258SBarry Smith @*/ 46147087cfbeSBarry Smith PetscErrorCode SNESSetDM(SNES snes,DM dm) 46156c699258SBarry Smith { 46166c699258SBarry Smith PetscErrorCode ierr; 4617345fed2cSBarry Smith KSP ksp; 4618942e3340SBarry Smith DMSNES sdm; 46196c699258SBarry Smith 46206c699258SBarry Smith PetscFunctionBegin; 46210700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 4622d0660788SBarry Smith if (dm) {ierr = PetscObjectReference((PetscObject)dm);CHKERRQ(ierr);} 4623942e3340SBarry Smith if (snes->dm) { /* Move the DMSNES context over to the new DM unless the new DM already has one */ 4624b4615a05SBarry Smith if (snes->dm->dmsnes && snes->dmAuto && !dm->dmsnes) { 4625942e3340SBarry Smith ierr = DMCopyDMSNES(snes->dm,dm);CHKERRQ(ierr); 4626942e3340SBarry Smith ierr = DMGetDMSNES(snes->dm,&sdm);CHKERRQ(ierr); 4627f5af7f23SKarl Rupp if (sdm->originaldm == snes->dm) sdm->originaldm = dm; /* Grant write privileges to the replacement DM */ 46286cab3a1bSJed Brown } 46296bf464f9SBarry Smith ierr = DMDestroy(&snes->dm);CHKERRQ(ierr); 46306cab3a1bSJed Brown } 46316c699258SBarry Smith snes->dm = dm; 4632116d1032SJed Brown snes->dmAuto = PETSC_FALSE; 4633f5af7f23SKarl Rupp 4634345fed2cSBarry Smith ierr = SNESGetKSP(snes,&ksp);CHKERRQ(ierr); 4635345fed2cSBarry Smith ierr = KSPSetDM(ksp,dm);CHKERRQ(ierr); 4636f22f69f0SBarry Smith ierr = KSPSetDMActive(ksp,PETSC_FALSE);CHKERRQ(ierr); 46372c155ee1SBarry Smith if (snes->pc) { 46382c155ee1SBarry Smith ierr = SNESSetDM(snes->pc, snes->dm);CHKERRQ(ierr); 4639c40d0f55SPeter Brune ierr = SNESSetPCSide(snes,snes->pcside);CHKERRQ(ierr); 46402c155ee1SBarry Smith } 46416c699258SBarry Smith PetscFunctionReturn(0); 46426c699258SBarry Smith } 46436c699258SBarry Smith 46446c699258SBarry Smith #undef __FUNCT__ 46456c699258SBarry Smith #define __FUNCT__ "SNESGetDM" 46466c699258SBarry Smith /*@ 46476c699258SBarry Smith SNESGetDM - Gets the DM that may be used by some preconditioners 46486c699258SBarry Smith 46493f9fe445SBarry Smith Not Collective but DM obtained is parallel on SNES 46506c699258SBarry Smith 46516c699258SBarry Smith Input Parameter: 46526c699258SBarry Smith . snes - the preconditioner context 46536c699258SBarry Smith 46546c699258SBarry Smith Output Parameter: 46556c699258SBarry Smith . dm - the dm 46566c699258SBarry Smith 46576c699258SBarry Smith Level: intermediate 46586c699258SBarry Smith 46596c699258SBarry Smith .seealso: SNESSetDM(), KSPSetDM(), KSPGetDM() 46606c699258SBarry Smith @*/ 46617087cfbeSBarry Smith PetscErrorCode SNESGetDM(SNES snes,DM *dm) 46626c699258SBarry Smith { 46636cab3a1bSJed Brown PetscErrorCode ierr; 46646cab3a1bSJed Brown 46656c699258SBarry Smith PetscFunctionBegin; 46660700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 46676cab3a1bSJed Brown if (!snes->dm) { 4668ce94432eSBarry Smith ierr = DMShellCreate(PetscObjectComm((PetscObject)snes),&snes->dm);CHKERRQ(ierr); 4669116d1032SJed Brown snes->dmAuto = PETSC_TRUE; 46706cab3a1bSJed Brown } 46716c699258SBarry Smith *dm = snes->dm; 46726c699258SBarry Smith PetscFunctionReturn(0); 46736c699258SBarry Smith } 46740807856dSBarry Smith 467531823bd8SMatthew G Knepley #undef __FUNCT__ 467631823bd8SMatthew G Knepley #define __FUNCT__ "SNESSetPC" 467731823bd8SMatthew G Knepley /*@ 4678fd4b34e9SJed Brown SNESSetPC - Sets the nonlinear preconditioner to be used. 467931823bd8SMatthew G Knepley 468031823bd8SMatthew G Knepley Collective on SNES 468131823bd8SMatthew G Knepley 468231823bd8SMatthew G Knepley Input Parameters: 468331823bd8SMatthew G Knepley + snes - iterative context obtained from SNESCreate() 468431823bd8SMatthew G Knepley - pc - the preconditioner object 468531823bd8SMatthew G Knepley 468631823bd8SMatthew G Knepley Notes: 468731823bd8SMatthew G Knepley Use SNESGetPC() to retrieve the preconditioner context (for example, 468831823bd8SMatthew G Knepley to configure it using the API). 468931823bd8SMatthew G Knepley 469031823bd8SMatthew G Knepley Level: developer 469131823bd8SMatthew G Knepley 469231823bd8SMatthew G Knepley .keywords: SNES, set, precondition 469331823bd8SMatthew G Knepley .seealso: SNESGetPC() 469431823bd8SMatthew G Knepley @*/ 469531823bd8SMatthew G Knepley PetscErrorCode SNESSetPC(SNES snes, SNES pc) 469631823bd8SMatthew G Knepley { 469731823bd8SMatthew G Knepley PetscErrorCode ierr; 469831823bd8SMatthew G Knepley 469931823bd8SMatthew G Knepley PetscFunctionBegin; 470031823bd8SMatthew G Knepley PetscValidHeaderSpecific(snes, SNES_CLASSID, 1); 470131823bd8SMatthew G Knepley PetscValidHeaderSpecific(pc, SNES_CLASSID, 2); 470231823bd8SMatthew G Knepley PetscCheckSameComm(snes, 1, pc, 2); 470331823bd8SMatthew G Knepley ierr = PetscObjectReference((PetscObject) pc);CHKERRQ(ierr); 4704bf11d3b6SBarry Smith ierr = SNESDestroy(&snes->pc);CHKERRQ(ierr); 470531823bd8SMatthew G Knepley snes->pc = pc; 47063bb1ff40SBarry Smith ierr = PetscLogObjectParent((PetscObject)snes, (PetscObject)snes->pc);CHKERRQ(ierr); 470731823bd8SMatthew G Knepley PetscFunctionReturn(0); 470831823bd8SMatthew G Knepley } 470931823bd8SMatthew G Knepley 471031823bd8SMatthew G Knepley #undef __FUNCT__ 471131823bd8SMatthew G Knepley #define __FUNCT__ "SNESGetPC" 471231823bd8SMatthew G Knepley /*@ 4713fd4b34e9SJed Brown SNESGetPC - Returns a pointer to the nonlinear preconditioning context set with SNESSetPC(). 471431823bd8SMatthew G Knepley 471531823bd8SMatthew G Knepley Not Collective 471631823bd8SMatthew G Knepley 471731823bd8SMatthew G Knepley Input Parameter: 471831823bd8SMatthew G Knepley . snes - iterative context obtained from SNESCreate() 471931823bd8SMatthew G Knepley 472031823bd8SMatthew G Knepley Output Parameter: 472131823bd8SMatthew G Knepley . pc - preconditioner context 472231823bd8SMatthew G Knepley 472331823bd8SMatthew G Knepley Level: developer 472431823bd8SMatthew G Knepley 472531823bd8SMatthew G Knepley .keywords: SNES, get, preconditioner 472631823bd8SMatthew G Knepley .seealso: SNESSetPC() 472731823bd8SMatthew G Knepley @*/ 472831823bd8SMatthew G Knepley PetscErrorCode SNESGetPC(SNES snes, SNES *pc) 472931823bd8SMatthew G Knepley { 473031823bd8SMatthew G Knepley PetscErrorCode ierr; 4731a64e098fSPeter Brune const char *optionsprefix; 473231823bd8SMatthew G Knepley 473331823bd8SMatthew G Knepley PetscFunctionBegin; 473431823bd8SMatthew G Knepley PetscValidHeaderSpecific(snes, SNES_CLASSID, 1); 473531823bd8SMatthew G Knepley PetscValidPointer(pc, 2); 473631823bd8SMatthew G Knepley if (!snes->pc) { 473782f516ccSBarry Smith ierr = SNESCreate(PetscObjectComm((PetscObject)snes),&snes->pc);CHKERRQ(ierr); 47384a0c5b0cSMatthew G Knepley ierr = PetscObjectIncrementTabLevel((PetscObject)snes->pc,(PetscObject)snes,1);CHKERRQ(ierr); 47393bb1ff40SBarry Smith ierr = PetscLogObjectParent((PetscObject)snes,(PetscObject)snes->pc);CHKERRQ(ierr); 4740a64e098fSPeter Brune ierr = SNESGetOptionsPrefix(snes,&optionsprefix);CHKERRQ(ierr); 4741a64e098fSPeter Brune ierr = SNESSetOptionsPrefix(snes->pc,optionsprefix);CHKERRQ(ierr); 4742a64e098fSPeter Brune ierr = SNESAppendOptionsPrefix(snes->pc,"npc_");CHKERRQ(ierr); 4743971e163fSPeter Brune ierr = SNESSetCountersReset(snes->pc,PETSC_FALSE);CHKERRQ(ierr); 474431823bd8SMatthew G Knepley } 474531823bd8SMatthew G Knepley *pc = snes->pc; 474631823bd8SMatthew G Knepley PetscFunctionReturn(0); 474731823bd8SMatthew G Knepley } 474831823bd8SMatthew G Knepley 4749c40d0f55SPeter Brune #undef __FUNCT__ 4750c40d0f55SPeter Brune #define __FUNCT__ "SNESSetPCSide" 4751c40d0f55SPeter Brune /*@ 4752c40d0f55SPeter Brune SNESSetPCSide - Sets the preconditioning side. 4753c40d0f55SPeter Brune 4754c40d0f55SPeter Brune Logically Collective on SNES 4755c40d0f55SPeter Brune 4756c40d0f55SPeter Brune Input Parameter: 4757c40d0f55SPeter Brune . snes - iterative context obtained from SNESCreate() 4758c40d0f55SPeter Brune 4759c40d0f55SPeter Brune Output Parameter: 4760c40d0f55SPeter Brune . side - the preconditioning side, where side is one of 4761c40d0f55SPeter Brune .vb 4762c40d0f55SPeter Brune PC_LEFT - left preconditioning (default) 4763c40d0f55SPeter Brune PC_RIGHT - right preconditioning 4764c40d0f55SPeter Brune .ve 4765c40d0f55SPeter Brune 4766c40d0f55SPeter Brune Options Database Keys: 4767c40d0f55SPeter Brune . -snes_pc_side <right,left> 4768c40d0f55SPeter Brune 4769c40d0f55SPeter Brune Level: intermediate 4770c40d0f55SPeter Brune 4771c40d0f55SPeter Brune .keywords: SNES, set, right, left, side, preconditioner, flag 4772c40d0f55SPeter Brune 4773c40d0f55SPeter Brune .seealso: SNESGetPCSide(), KSPSetPCSide() 4774c40d0f55SPeter Brune @*/ 4775c40d0f55SPeter Brune PetscErrorCode SNESSetPCSide(SNES snes,PCSide side) 4776c40d0f55SPeter Brune { 4777c40d0f55SPeter Brune PetscFunctionBegin; 4778c40d0f55SPeter Brune PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 4779c40d0f55SPeter Brune PetscValidLogicalCollectiveEnum(snes,side,2); 4780c40d0f55SPeter Brune snes->pcside = side; 4781c40d0f55SPeter Brune PetscFunctionReturn(0); 4782c40d0f55SPeter Brune } 4783c40d0f55SPeter Brune 4784c40d0f55SPeter Brune #undef __FUNCT__ 4785c40d0f55SPeter Brune #define __FUNCT__ "SNESGetPCSide" 4786c40d0f55SPeter Brune /*@ 4787c40d0f55SPeter Brune SNESGetPCSide - Gets the preconditioning side. 4788c40d0f55SPeter Brune 4789c40d0f55SPeter Brune Not Collective 4790c40d0f55SPeter Brune 4791c40d0f55SPeter Brune Input Parameter: 4792c40d0f55SPeter Brune . snes - iterative context obtained from SNESCreate() 4793c40d0f55SPeter Brune 4794c40d0f55SPeter Brune Output Parameter: 4795c40d0f55SPeter Brune . side - the preconditioning side, where side is one of 4796c40d0f55SPeter Brune .vb 4797c40d0f55SPeter Brune PC_LEFT - left preconditioning (default) 4798c40d0f55SPeter Brune PC_RIGHT - right preconditioning 4799c40d0f55SPeter Brune .ve 4800c40d0f55SPeter Brune 4801c40d0f55SPeter Brune Level: intermediate 4802c40d0f55SPeter Brune 4803c40d0f55SPeter Brune .keywords: SNES, get, right, left, side, preconditioner, flag 4804c40d0f55SPeter Brune 4805c40d0f55SPeter Brune .seealso: SNESSetPCSide(), KSPGetPCSide() 4806c40d0f55SPeter Brune @*/ 4807c40d0f55SPeter Brune PetscErrorCode SNESGetPCSide(SNES snes,PCSide *side) 4808c40d0f55SPeter Brune { 4809c40d0f55SPeter Brune PetscFunctionBegin; 4810c40d0f55SPeter Brune PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 4811c40d0f55SPeter Brune PetscValidPointer(side,2); 4812c40d0f55SPeter Brune *side = snes->pcside; 4813c40d0f55SPeter Brune PetscFunctionReturn(0); 4814c40d0f55SPeter Brune } 4815c40d0f55SPeter Brune 48169e764e56SPeter Brune #undef __FUNCT__ 48177601faf0SJed Brown #define __FUNCT__ "SNESSetLineSearch" 48189e764e56SPeter Brune /*@ 48197601faf0SJed Brown SNESSetLineSearch - Sets the linesearch on the SNES instance. 48209e764e56SPeter Brune 48219e764e56SPeter Brune Collective on SNES 48229e764e56SPeter Brune 48239e764e56SPeter Brune Input Parameters: 48249e764e56SPeter Brune + snes - iterative context obtained from SNESCreate() 48259e764e56SPeter Brune - linesearch - the linesearch object 48269e764e56SPeter Brune 48279e764e56SPeter Brune Notes: 48287601faf0SJed Brown Use SNESGetLineSearch() to retrieve the preconditioner context (for example, 48299e764e56SPeter Brune to configure it using the API). 48309e764e56SPeter Brune 48319e764e56SPeter Brune Level: developer 48329e764e56SPeter Brune 48339e764e56SPeter Brune .keywords: SNES, set, linesearch 48347601faf0SJed Brown .seealso: SNESGetLineSearch() 48359e764e56SPeter Brune @*/ 48367601faf0SJed Brown PetscErrorCode SNESSetLineSearch(SNES snes, SNESLineSearch linesearch) 48379e764e56SPeter Brune { 48389e764e56SPeter Brune PetscErrorCode ierr; 48399e764e56SPeter Brune 48409e764e56SPeter Brune PetscFunctionBegin; 48419e764e56SPeter Brune PetscValidHeaderSpecific(snes, SNES_CLASSID, 1); 4842f1c6b773SPeter Brune PetscValidHeaderSpecific(linesearch, SNESLINESEARCH_CLASSID, 2); 48439e764e56SPeter Brune PetscCheckSameComm(snes, 1, linesearch, 2); 48449e764e56SPeter Brune ierr = PetscObjectReference((PetscObject) linesearch);CHKERRQ(ierr); 4845f1c6b773SPeter Brune ierr = SNESLineSearchDestroy(&snes->linesearch);CHKERRQ(ierr); 4846f5af7f23SKarl Rupp 48479e764e56SPeter Brune snes->linesearch = linesearch; 4848f5af7f23SKarl Rupp 48493bb1ff40SBarry Smith ierr = PetscLogObjectParent((PetscObject)snes, (PetscObject)snes->linesearch);CHKERRQ(ierr); 48509e764e56SPeter Brune PetscFunctionReturn(0); 48519e764e56SPeter Brune } 48529e764e56SPeter Brune 48539e764e56SPeter Brune #undef __FUNCT__ 48547601faf0SJed Brown #define __FUNCT__ "SNESGetLineSearch" 4855a34ceb2aSJed Brown /*@ 48567601faf0SJed Brown SNESGetLineSearch - Returns a pointer to the line search context set with SNESSetLineSearch() 48578141a3b9SPeter Brune or creates a default line search instance associated with the SNES and returns it. 48589e764e56SPeter Brune 48599e764e56SPeter Brune Not Collective 48609e764e56SPeter Brune 48619e764e56SPeter Brune Input Parameter: 48629e764e56SPeter Brune . snes - iterative context obtained from SNESCreate() 48639e764e56SPeter Brune 48649e764e56SPeter Brune Output Parameter: 48659e764e56SPeter Brune . linesearch - linesearch context 48669e764e56SPeter Brune 48679e764e56SPeter Brune Level: developer 48689e764e56SPeter Brune 48699e764e56SPeter Brune .keywords: SNES, get, linesearch 48707601faf0SJed Brown .seealso: SNESSetLineSearch() 48719e764e56SPeter Brune @*/ 48727601faf0SJed Brown PetscErrorCode SNESGetLineSearch(SNES snes, SNESLineSearch *linesearch) 48739e764e56SPeter Brune { 48749e764e56SPeter Brune PetscErrorCode ierr; 48759e764e56SPeter Brune const char *optionsprefix; 48769e764e56SPeter Brune 48779e764e56SPeter Brune PetscFunctionBegin; 48789e764e56SPeter Brune PetscValidHeaderSpecific(snes, SNES_CLASSID, 1); 48799e764e56SPeter Brune PetscValidPointer(linesearch, 2); 48809e764e56SPeter Brune if (!snes->linesearch) { 48819e764e56SPeter Brune ierr = SNESGetOptionsPrefix(snes, &optionsprefix);CHKERRQ(ierr); 488282f516ccSBarry Smith ierr = SNESLineSearchCreate(PetscObjectComm((PetscObject)snes), &snes->linesearch);CHKERRQ(ierr); 4883f1c6b773SPeter Brune ierr = SNESLineSearchSetSNES(snes->linesearch, snes);CHKERRQ(ierr); 4884b1dca40bSPeter Brune ierr = SNESLineSearchAppendOptionsPrefix(snes->linesearch, optionsprefix);CHKERRQ(ierr); 48859e764e56SPeter Brune ierr = PetscObjectIncrementTabLevel((PetscObject) snes->linesearch, (PetscObject) snes, 1);CHKERRQ(ierr); 48863bb1ff40SBarry Smith ierr = PetscLogObjectParent((PetscObject)snes, (PetscObject)snes->linesearch);CHKERRQ(ierr); 48879e764e56SPeter Brune } 48889e764e56SPeter Brune *linesearch = snes->linesearch; 48899e764e56SPeter Brune PetscFunctionReturn(0); 48909e764e56SPeter Brune } 48919e764e56SPeter Brune 489269b4f73cSBarry Smith #if defined(PETSC_HAVE_MATLAB_ENGINE) 4893c6db04a5SJed Brown #include <mex.h> 489469b4f73cSBarry Smith 48958f6e6473SBarry Smith typedef struct {char *funcname; mxArray *ctx;} SNESMatlabContext; 48968f6e6473SBarry Smith 48970807856dSBarry Smith #undef __FUNCT__ 48980807856dSBarry Smith #define __FUNCT__ "SNESComputeFunction_Matlab" 48990807856dSBarry Smith /* 4900bf388a1fSBarry Smith SNESComputeFunction_Matlab - Calls the function that has been set with SNESSetFunctionMatlab(). 49010807856dSBarry Smith 49020807856dSBarry Smith Collective on SNES 49030807856dSBarry Smith 49040807856dSBarry Smith Input Parameters: 49050807856dSBarry Smith + snes - the SNES context 49060807856dSBarry Smith - x - input vector 49070807856dSBarry Smith 49080807856dSBarry Smith Output Parameter: 49090807856dSBarry Smith . y - function vector, as set by SNESSetFunction() 49100807856dSBarry Smith 49110807856dSBarry Smith Notes: 49120807856dSBarry Smith SNESComputeFunction() is typically used within nonlinear solvers 49130807856dSBarry Smith implementations, so most users would not generally call this routine 49140807856dSBarry Smith themselves. 49150807856dSBarry Smith 49160807856dSBarry Smith Level: developer 49170807856dSBarry Smith 49180807856dSBarry Smith .keywords: SNES, nonlinear, compute, function 49190807856dSBarry Smith 49200807856dSBarry Smith .seealso: SNESSetFunction(), SNESGetFunction() 492161b2408cSBarry Smith */ 49227087cfbeSBarry Smith PetscErrorCode SNESComputeFunction_Matlab(SNES snes,Vec x,Vec y, void *ctx) 49230807856dSBarry Smith { 4924e650e774SBarry Smith PetscErrorCode ierr; 49258f6e6473SBarry Smith SNESMatlabContext *sctx = (SNESMatlabContext*)ctx; 49268f6e6473SBarry Smith int nlhs = 1,nrhs = 5; 49278f6e6473SBarry Smith mxArray *plhs[1],*prhs[5]; 492891621f2eSBarry Smith long long int lx = 0,ly = 0,ls = 0; 4929e650e774SBarry Smith 49300807856dSBarry Smith PetscFunctionBegin; 49310807856dSBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 49320807856dSBarry Smith PetscValidHeaderSpecific(x,VEC_CLASSID,2); 49330807856dSBarry Smith PetscValidHeaderSpecific(y,VEC_CLASSID,3); 49340807856dSBarry Smith PetscCheckSameComm(snes,1,x,2); 49350807856dSBarry Smith PetscCheckSameComm(snes,1,y,3); 49360807856dSBarry Smith 49370807856dSBarry Smith /* call Matlab function in ctx with arguments x and y */ 4938e650e774SBarry Smith 493991621f2eSBarry Smith ierr = PetscMemcpy(&ls,&snes,sizeof(snes));CHKERRQ(ierr); 4940e650e774SBarry Smith ierr = PetscMemcpy(&lx,&x,sizeof(x));CHKERRQ(ierr); 4941e650e774SBarry Smith ierr = PetscMemcpy(&ly,&y,sizeof(x));CHKERRQ(ierr); 494291621f2eSBarry Smith prhs[0] = mxCreateDoubleScalar((double)ls); 494391621f2eSBarry Smith prhs[1] = mxCreateDoubleScalar((double)lx); 494491621f2eSBarry Smith prhs[2] = mxCreateDoubleScalar((double)ly); 49458f6e6473SBarry Smith prhs[3] = mxCreateString(sctx->funcname); 49468f6e6473SBarry Smith prhs[4] = sctx->ctx; 4947b807a863SBarry Smith ierr = mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscSNESComputeFunctionInternal");CHKERRQ(ierr); 4948e650e774SBarry Smith ierr = mxGetScalar(plhs[0]);CHKERRQ(ierr); 4949e650e774SBarry Smith mxDestroyArray(prhs[0]); 4950e650e774SBarry Smith mxDestroyArray(prhs[1]); 4951e650e774SBarry Smith mxDestroyArray(prhs[2]); 49528f6e6473SBarry Smith mxDestroyArray(prhs[3]); 4953e650e774SBarry Smith mxDestroyArray(plhs[0]); 49540807856dSBarry Smith PetscFunctionReturn(0); 49550807856dSBarry Smith } 49560807856dSBarry Smith 49570807856dSBarry Smith #undef __FUNCT__ 49580807856dSBarry Smith #define __FUNCT__ "SNESSetFunctionMatlab" 495961b2408cSBarry Smith /* 49600807856dSBarry Smith SNESSetFunctionMatlab - Sets the function evaluation routine and function 49610807856dSBarry Smith vector for use by the SNES routines in solving systems of nonlinear 4962e3c5b3baSBarry Smith equations from MATLAB. Here the function is a string containing the name of a MATLAB function 49630807856dSBarry Smith 49640807856dSBarry Smith Logically Collective on SNES 49650807856dSBarry Smith 49660807856dSBarry Smith Input Parameters: 49670807856dSBarry Smith + snes - the SNES context 49680807856dSBarry Smith . r - vector to store function value 4969bf388a1fSBarry Smith - SNESFunction - function evaluation routine 49700807856dSBarry Smith 49710807856dSBarry Smith Notes: 49720807856dSBarry Smith The Newton-like methods typically solve linear systems of the form 49730807856dSBarry Smith $ f'(x) x = -f(x), 49740807856dSBarry Smith where f'(x) denotes the Jacobian matrix and f(x) is the function. 49750807856dSBarry Smith 49760807856dSBarry Smith Level: beginner 49770807856dSBarry Smith 4978c5b75c40SBarry Smith Developer Note: This bleeds the allocated memory SNESMatlabContext *sctx; 4979c5b75c40SBarry Smith 49800807856dSBarry Smith .keywords: SNES, nonlinear, set, function 49810807856dSBarry Smith 49820807856dSBarry Smith .seealso: SNESGetFunction(), SNESComputeFunction(), SNESSetJacobian(), SNESSetFunction() 498361b2408cSBarry Smith */ 4984bf388a1fSBarry Smith PetscErrorCode SNESSetFunctionMatlab(SNES snes,Vec r,const char *SNESFunction,mxArray *ctx) 49850807856dSBarry Smith { 49860807856dSBarry Smith PetscErrorCode ierr; 49878f6e6473SBarry Smith SNESMatlabContext *sctx; 49880807856dSBarry Smith 49890807856dSBarry Smith PetscFunctionBegin; 49908f6e6473SBarry Smith /* currently sctx is memory bleed */ 49918f6e6473SBarry Smith ierr = PetscMalloc(sizeof(SNESMatlabContext),&sctx);CHKERRQ(ierr); 4992bf388a1fSBarry Smith ierr = PetscStrallocpy(SNESFunction,&sctx->funcname);CHKERRQ(ierr); 49938f6e6473SBarry Smith /* 49948f6e6473SBarry Smith This should work, but it doesn't 49958f6e6473SBarry Smith sctx->ctx = ctx; 49968f6e6473SBarry Smith mexMakeArrayPersistent(sctx->ctx); 49978f6e6473SBarry Smith */ 49988f6e6473SBarry Smith sctx->ctx = mxDuplicateArray(ctx); 49998f6e6473SBarry Smith ierr = SNESSetFunction(snes,r,SNESComputeFunction_Matlab,sctx);CHKERRQ(ierr); 50000807856dSBarry Smith PetscFunctionReturn(0); 50010807856dSBarry Smith } 500269b4f73cSBarry Smith 500361b2408cSBarry Smith #undef __FUNCT__ 500461b2408cSBarry Smith #define __FUNCT__ "SNESComputeJacobian_Matlab" 500561b2408cSBarry Smith /* 5006bf388a1fSBarry Smith SNESComputeJacobian_Matlab - Calls the function that has been set with SNESSetJacobianMatlab(). 500761b2408cSBarry Smith 500861b2408cSBarry Smith Collective on SNES 500961b2408cSBarry Smith 501061b2408cSBarry Smith Input Parameters: 501161b2408cSBarry Smith + snes - the SNES context 501261b2408cSBarry Smith . x - input vector 501361b2408cSBarry Smith . A, B - the matrices 501461b2408cSBarry Smith - ctx - user context 501561b2408cSBarry Smith 501661b2408cSBarry Smith Output Parameter: 501761b2408cSBarry Smith . flag - structure of the matrix 501861b2408cSBarry Smith 501961b2408cSBarry Smith Level: developer 502061b2408cSBarry Smith 502161b2408cSBarry Smith .keywords: SNES, nonlinear, compute, function 502261b2408cSBarry Smith 502361b2408cSBarry Smith .seealso: SNESSetFunction(), SNESGetFunction() 502461b2408cSBarry Smith @*/ 50257087cfbeSBarry Smith PetscErrorCode SNESComputeJacobian_Matlab(SNES snes,Vec x,Mat *A,Mat *B,MatStructure *flag, void *ctx) 502661b2408cSBarry Smith { 502761b2408cSBarry Smith PetscErrorCode ierr; 502861b2408cSBarry Smith SNESMatlabContext *sctx = (SNESMatlabContext*)ctx; 502961b2408cSBarry Smith int nlhs = 2,nrhs = 6; 503061b2408cSBarry Smith mxArray *plhs[2],*prhs[6]; 503161b2408cSBarry Smith long long int lx = 0,lA = 0,ls = 0, lB = 0; 503261b2408cSBarry Smith 503361b2408cSBarry Smith PetscFunctionBegin; 503461b2408cSBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 503561b2408cSBarry Smith PetscValidHeaderSpecific(x,VEC_CLASSID,2); 503661b2408cSBarry Smith 503761b2408cSBarry Smith /* call Matlab function in ctx with arguments x and y */ 503861b2408cSBarry Smith 503961b2408cSBarry Smith ierr = PetscMemcpy(&ls,&snes,sizeof(snes));CHKERRQ(ierr); 504061b2408cSBarry Smith ierr = PetscMemcpy(&lx,&x,sizeof(x));CHKERRQ(ierr); 504161b2408cSBarry Smith ierr = PetscMemcpy(&lA,A,sizeof(x));CHKERRQ(ierr); 504261b2408cSBarry Smith ierr = PetscMemcpy(&lB,B,sizeof(x));CHKERRQ(ierr); 504361b2408cSBarry Smith prhs[0] = mxCreateDoubleScalar((double)ls); 504461b2408cSBarry Smith prhs[1] = mxCreateDoubleScalar((double)lx); 504561b2408cSBarry Smith prhs[2] = mxCreateDoubleScalar((double)lA); 504661b2408cSBarry Smith prhs[3] = mxCreateDoubleScalar((double)lB); 504761b2408cSBarry Smith prhs[4] = mxCreateString(sctx->funcname); 504861b2408cSBarry Smith prhs[5] = sctx->ctx; 5049b807a863SBarry Smith ierr = mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscSNESComputeJacobianInternal");CHKERRQ(ierr); 505061b2408cSBarry Smith ierr = mxGetScalar(plhs[0]);CHKERRQ(ierr); 505161b2408cSBarry Smith *flag = (MatStructure) mxGetScalar(plhs[1]);CHKERRQ(ierr); 505261b2408cSBarry Smith mxDestroyArray(prhs[0]); 505361b2408cSBarry Smith mxDestroyArray(prhs[1]); 505461b2408cSBarry Smith mxDestroyArray(prhs[2]); 505561b2408cSBarry Smith mxDestroyArray(prhs[3]); 505661b2408cSBarry Smith mxDestroyArray(prhs[4]); 505761b2408cSBarry Smith mxDestroyArray(plhs[0]); 505861b2408cSBarry Smith mxDestroyArray(plhs[1]); 505961b2408cSBarry Smith PetscFunctionReturn(0); 506061b2408cSBarry Smith } 506161b2408cSBarry Smith 506261b2408cSBarry Smith #undef __FUNCT__ 506361b2408cSBarry Smith #define __FUNCT__ "SNESSetJacobianMatlab" 506461b2408cSBarry Smith /* 506561b2408cSBarry Smith SNESSetJacobianMatlab - Sets the Jacobian function evaluation routine and two empty Jacobian matrices 506661b2408cSBarry Smith vector for use by the SNES routines in solving systems of nonlinear 5067e3c5b3baSBarry Smith equations from MATLAB. Here the function is a string containing the name of a MATLAB function 506861b2408cSBarry Smith 506961b2408cSBarry Smith Logically Collective on SNES 507061b2408cSBarry Smith 507161b2408cSBarry Smith Input Parameters: 507261b2408cSBarry Smith + snes - the SNES context 507361b2408cSBarry Smith . A,B - Jacobian matrices 5074bf388a1fSBarry Smith . SNESJacobianFunction - function evaluation routine 507561b2408cSBarry Smith - ctx - user context 507661b2408cSBarry Smith 507761b2408cSBarry Smith Level: developer 507861b2408cSBarry Smith 5079c5b75c40SBarry Smith Developer Note: This bleeds the allocated memory SNESMatlabContext *sctx; 5080c5b75c40SBarry Smith 508161b2408cSBarry Smith .keywords: SNES, nonlinear, set, function 508261b2408cSBarry Smith 5083bf388a1fSBarry Smith .seealso: SNESGetFunction(), SNESComputeFunction(), SNESSetJacobian(), SNESSetFunction(), SNESJacobianFunction 508461b2408cSBarry Smith */ 5085bf388a1fSBarry Smith PetscErrorCode SNESSetJacobianMatlab(SNES snes,Mat A,Mat B,const char *SNESJacobianFunction,mxArray *ctx) 508661b2408cSBarry Smith { 508761b2408cSBarry Smith PetscErrorCode ierr; 508861b2408cSBarry Smith SNESMatlabContext *sctx; 508961b2408cSBarry Smith 509061b2408cSBarry Smith PetscFunctionBegin; 509161b2408cSBarry Smith /* currently sctx is memory bleed */ 509261b2408cSBarry Smith ierr = PetscMalloc(sizeof(SNESMatlabContext),&sctx);CHKERRQ(ierr); 5093bf388a1fSBarry Smith ierr = PetscStrallocpy(SNESJacobianFunction,&sctx->funcname);CHKERRQ(ierr); 509461b2408cSBarry Smith /* 509561b2408cSBarry Smith This should work, but it doesn't 509661b2408cSBarry Smith sctx->ctx = ctx; 509761b2408cSBarry Smith mexMakeArrayPersistent(sctx->ctx); 509861b2408cSBarry Smith */ 509961b2408cSBarry Smith sctx->ctx = mxDuplicateArray(ctx); 510061b2408cSBarry Smith ierr = SNESSetJacobian(snes,A,B,SNESComputeJacobian_Matlab,sctx);CHKERRQ(ierr); 510161b2408cSBarry Smith PetscFunctionReturn(0); 510261b2408cSBarry Smith } 510369b4f73cSBarry Smith 5104f9eb7ae2SShri Abhyankar #undef __FUNCT__ 5105f9eb7ae2SShri Abhyankar #define __FUNCT__ "SNESMonitor_Matlab" 5106f9eb7ae2SShri Abhyankar /* 5107f9eb7ae2SShri Abhyankar SNESMonitor_Matlab - Calls the function that has been set with SNESMonitorSetMatlab(). 5108f9eb7ae2SShri Abhyankar 5109f9eb7ae2SShri Abhyankar Collective on SNES 5110f9eb7ae2SShri Abhyankar 5111f9eb7ae2SShri Abhyankar .seealso: SNESSetFunction(), SNESGetFunction() 5112f9eb7ae2SShri Abhyankar @*/ 51137087cfbeSBarry Smith PetscErrorCode SNESMonitor_Matlab(SNES snes,PetscInt it, PetscReal fnorm, void *ctx) 5114f9eb7ae2SShri Abhyankar { 5115f9eb7ae2SShri Abhyankar PetscErrorCode ierr; 511648f37e70SShri Abhyankar SNESMatlabContext *sctx = (SNESMatlabContext*)ctx; 5117f9eb7ae2SShri Abhyankar int nlhs = 1,nrhs = 6; 5118f9eb7ae2SShri Abhyankar mxArray *plhs[1],*prhs[6]; 5119f9eb7ae2SShri Abhyankar long long int lx = 0,ls = 0; 5120f9eb7ae2SShri Abhyankar Vec x = snes->vec_sol; 5121f9eb7ae2SShri Abhyankar 5122f9eb7ae2SShri Abhyankar PetscFunctionBegin; 5123f9eb7ae2SShri Abhyankar PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 5124f9eb7ae2SShri Abhyankar 5125f9eb7ae2SShri Abhyankar ierr = PetscMemcpy(&ls,&snes,sizeof(snes));CHKERRQ(ierr); 5126f9eb7ae2SShri Abhyankar ierr = PetscMemcpy(&lx,&x,sizeof(x));CHKERRQ(ierr); 5127f9eb7ae2SShri Abhyankar prhs[0] = mxCreateDoubleScalar((double)ls); 5128f9eb7ae2SShri Abhyankar prhs[1] = mxCreateDoubleScalar((double)it); 5129f9eb7ae2SShri Abhyankar prhs[2] = mxCreateDoubleScalar((double)fnorm); 5130f9eb7ae2SShri Abhyankar prhs[3] = mxCreateDoubleScalar((double)lx); 5131f9eb7ae2SShri Abhyankar prhs[4] = mxCreateString(sctx->funcname); 5132f9eb7ae2SShri Abhyankar prhs[5] = sctx->ctx; 5133f9eb7ae2SShri Abhyankar ierr = mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscSNESMonitorInternal");CHKERRQ(ierr); 5134f9eb7ae2SShri Abhyankar ierr = mxGetScalar(plhs[0]);CHKERRQ(ierr); 5135f9eb7ae2SShri Abhyankar mxDestroyArray(prhs[0]); 5136f9eb7ae2SShri Abhyankar mxDestroyArray(prhs[1]); 5137f9eb7ae2SShri Abhyankar mxDestroyArray(prhs[2]); 5138f9eb7ae2SShri Abhyankar mxDestroyArray(prhs[3]); 5139f9eb7ae2SShri Abhyankar mxDestroyArray(prhs[4]); 5140f9eb7ae2SShri Abhyankar mxDestroyArray(plhs[0]); 5141f9eb7ae2SShri Abhyankar PetscFunctionReturn(0); 5142f9eb7ae2SShri Abhyankar } 5143f9eb7ae2SShri Abhyankar 5144f9eb7ae2SShri Abhyankar #undef __FUNCT__ 5145f9eb7ae2SShri Abhyankar #define __FUNCT__ "SNESMonitorSetMatlab" 5146f9eb7ae2SShri Abhyankar /* 5147e3c5b3baSBarry Smith SNESMonitorSetMatlab - Sets the monitor function from MATLAB 5148f9eb7ae2SShri Abhyankar 5149f9eb7ae2SShri Abhyankar Level: developer 5150f9eb7ae2SShri Abhyankar 5151c5b75c40SBarry Smith Developer Note: This bleeds the allocated memory SNESMatlabContext *sctx; 5152c5b75c40SBarry Smith 5153f9eb7ae2SShri Abhyankar .keywords: SNES, nonlinear, set, function 5154f9eb7ae2SShri Abhyankar 5155f9eb7ae2SShri Abhyankar .seealso: SNESGetFunction(), SNESComputeFunction(), SNESSetJacobian(), SNESSetFunction() 5156f9eb7ae2SShri Abhyankar */ 5157bf388a1fSBarry Smith PetscErrorCode SNESMonitorSetMatlab(SNES snes,const char *SNESMonitorFunction,mxArray *ctx) 5158f9eb7ae2SShri Abhyankar { 5159f9eb7ae2SShri Abhyankar PetscErrorCode ierr; 5160f9eb7ae2SShri Abhyankar SNESMatlabContext *sctx; 5161f9eb7ae2SShri Abhyankar 5162f9eb7ae2SShri Abhyankar PetscFunctionBegin; 5163f9eb7ae2SShri Abhyankar /* currently sctx is memory bleed */ 5164f9eb7ae2SShri Abhyankar ierr = PetscMalloc(sizeof(SNESMatlabContext),&sctx);CHKERRQ(ierr); 5165bf388a1fSBarry Smith ierr = PetscStrallocpy(SNESMonitorFunction,&sctx->funcname);CHKERRQ(ierr); 5166f9eb7ae2SShri Abhyankar /* 5167f9eb7ae2SShri Abhyankar This should work, but it doesn't 5168f9eb7ae2SShri Abhyankar sctx->ctx = ctx; 5169f9eb7ae2SShri Abhyankar mexMakeArrayPersistent(sctx->ctx); 5170f9eb7ae2SShri Abhyankar */ 5171f9eb7ae2SShri Abhyankar sctx->ctx = mxDuplicateArray(ctx); 51720298fd71SBarry Smith ierr = SNESMonitorSet(snes,SNESMonitor_Matlab,sctx,NULL);CHKERRQ(ierr); 5173f9eb7ae2SShri Abhyankar PetscFunctionReturn(0); 5174f9eb7ae2SShri Abhyankar } 5175f9eb7ae2SShri Abhyankar 517669b4f73cSBarry Smith #endif 5177