12b4ed282SShri Abhyankar 2c6db04a5SJed Brown #include <../src/snes/impls/vi/viimpl.h> /*I "petscsnes.h" I*/ 3c6db04a5SJed Brown #include <../include/private/kspimpl.h> 4c6db04a5SJed Brown #include <../include/private/matimpl.h> 52b4ed282SShri Abhyankar 69308c137SBarry Smith #undef __FUNCT__ 79308c137SBarry Smith #define __FUNCT__ "SNESMonitorVI" 87087cfbeSBarry Smith PetscErrorCode SNESMonitorVI(SNES snes,PetscInt its,PetscReal fgnorm,void *dummy) 99308c137SBarry Smith { 109308c137SBarry Smith PetscErrorCode ierr; 119308c137SBarry Smith SNES_VI *vi = (SNES_VI*)snes->data; 129308c137SBarry Smith PetscViewerASCIIMonitor viewer = (PetscViewerASCIIMonitor) dummy; 139308c137SBarry Smith const PetscScalar *x,*xl,*xu,*f; 1409573ac7SBarry Smith PetscInt i,n,act = 0; 159308c137SBarry Smith PetscReal rnorm,fnorm; 169308c137SBarry Smith 179308c137SBarry Smith PetscFunctionBegin; 189308c137SBarry Smith if (!dummy) { 199308c137SBarry Smith ierr = PetscViewerASCIIMonitorCreate(((PetscObject)snes)->comm,"stdout",0,&viewer);CHKERRQ(ierr); 209308c137SBarry Smith } 219308c137SBarry Smith ierr = VecGetLocalSize(snes->vec_sol,&n);CHKERRQ(ierr); 229308c137SBarry Smith ierr = VecGetArrayRead(vi->xl,&xl);CHKERRQ(ierr); 239308c137SBarry Smith ierr = VecGetArrayRead(vi->xu,&xu);CHKERRQ(ierr); 249308c137SBarry Smith ierr = VecGetArrayRead(snes->vec_sol,&x);CHKERRQ(ierr); 253f731af5SBarry Smith ierr = VecGetArrayRead(snes->vec_func,&f);CHKERRQ(ierr); 269308c137SBarry Smith 279308c137SBarry Smith rnorm = 0.0; 289308c137SBarry Smith for (i=0; i<n; i++) { 297b2c10efSShri Abhyankar if (((x[i] > xl[i] + 1.e-8 || (f[i] < 0.0)) && ((x[i] < xu[i] - 1.e-8) || f[i] > 0.0))) rnorm += f[i]*f[i]; 3009573ac7SBarry Smith else act++; 319308c137SBarry Smith } 323f731af5SBarry Smith ierr = VecRestoreArrayRead(snes->vec_func,&f);CHKERRQ(ierr); 339308c137SBarry Smith ierr = VecRestoreArrayRead(vi->xl,&xl);CHKERRQ(ierr); 349308c137SBarry Smith ierr = VecRestoreArrayRead(vi->xu,&xu);CHKERRQ(ierr); 359308c137SBarry Smith ierr = VecRestoreArrayRead(snes->vec_sol,&x);CHKERRQ(ierr); 36d9822059SBarry Smith ierr = MPI_Allreduce(&rnorm,&fnorm,1,MPIU_REAL,MPIU_SUM,((PetscObject)snes)->comm);CHKERRQ(ierr); 379308c137SBarry Smith fnorm = sqrt(fnorm); 3809573ac7SBarry Smith ierr = PetscViewerASCIIMonitorPrintf(viewer,"%3D SNES VI Function norm %14.12e Active constraints %D\n",its,fnorm,act);CHKERRQ(ierr); 399308c137SBarry Smith if (!dummy) { 406bf464f9SBarry Smith ierr = PetscViewerASCIIMonitorDestroy(&viewer);CHKERRQ(ierr); 419308c137SBarry Smith } 429308c137SBarry Smith PetscFunctionReturn(0); 439308c137SBarry Smith } 449308c137SBarry Smith 452b4ed282SShri Abhyankar /* 462b4ed282SShri Abhyankar Checks if J^T F = 0 which implies we've found a local minimum of the norm of the function, 472b4ed282SShri Abhyankar || F(u) ||_2 but not a zero, F(u) = 0. In the case when one cannot compute J^T F we use the fact that 482b4ed282SShri Abhyankar 0 = (J^T F)^T W = F^T J W iff W not in the null space of J. Thanks for Jorge More 492b4ed282SShri Abhyankar for this trick. One assumes that the probability that W is in the null space of J is very, very small. 502b4ed282SShri Abhyankar */ 512b4ed282SShri Abhyankar #undef __FUNCT__ 522b4ed282SShri Abhyankar #define __FUNCT__ "SNESVICheckLocalMin_Private" 53ace3abfcSBarry Smith PetscErrorCode SNESVICheckLocalMin_Private(SNES snes,Mat A,Vec F,Vec W,PetscReal fnorm,PetscBool *ismin) 542b4ed282SShri Abhyankar { 552b4ed282SShri Abhyankar PetscReal a1; 562b4ed282SShri Abhyankar PetscErrorCode ierr; 57ace3abfcSBarry Smith PetscBool hastranspose; 582b4ed282SShri Abhyankar 592b4ed282SShri Abhyankar PetscFunctionBegin; 602b4ed282SShri Abhyankar *ismin = PETSC_FALSE; 612b4ed282SShri Abhyankar ierr = MatHasOperation(A,MATOP_MULT_TRANSPOSE,&hastranspose);CHKERRQ(ierr); 622b4ed282SShri Abhyankar if (hastranspose) { 632b4ed282SShri Abhyankar /* Compute || J^T F|| */ 642b4ed282SShri Abhyankar ierr = MatMultTranspose(A,F,W);CHKERRQ(ierr); 652b4ed282SShri Abhyankar ierr = VecNorm(W,NORM_2,&a1);CHKERRQ(ierr); 662b4ed282SShri Abhyankar ierr = PetscInfo1(snes,"|| J^T F|| %G near zero implies found a local minimum\n",a1/fnorm);CHKERRQ(ierr); 672b4ed282SShri Abhyankar if (a1/fnorm < 1.e-4) *ismin = PETSC_TRUE; 682b4ed282SShri Abhyankar } else { 692b4ed282SShri Abhyankar Vec work; 702b4ed282SShri Abhyankar PetscScalar result; 712b4ed282SShri Abhyankar PetscReal wnorm; 722b4ed282SShri Abhyankar 732b4ed282SShri Abhyankar ierr = VecSetRandom(W,PETSC_NULL);CHKERRQ(ierr); 742b4ed282SShri Abhyankar ierr = VecNorm(W,NORM_2,&wnorm);CHKERRQ(ierr); 752b4ed282SShri Abhyankar ierr = VecDuplicate(W,&work);CHKERRQ(ierr); 762b4ed282SShri Abhyankar ierr = MatMult(A,W,work);CHKERRQ(ierr); 772b4ed282SShri Abhyankar ierr = VecDot(F,work,&result);CHKERRQ(ierr); 786bf464f9SBarry Smith ierr = VecDestroy(&work);CHKERRQ(ierr); 792b4ed282SShri Abhyankar a1 = PetscAbsScalar(result)/(fnorm*wnorm); 802b4ed282SShri Abhyankar ierr = PetscInfo1(snes,"(F^T J random)/(|| F ||*||random|| %G near zero implies found a local minimum\n",a1);CHKERRQ(ierr); 812b4ed282SShri Abhyankar if (a1 < 1.e-4) *ismin = PETSC_TRUE; 822b4ed282SShri Abhyankar } 832b4ed282SShri Abhyankar PetscFunctionReturn(0); 842b4ed282SShri Abhyankar } 852b4ed282SShri Abhyankar 862b4ed282SShri Abhyankar /* 872b4ed282SShri Abhyankar Checks if J^T(F - J*X) = 0 882b4ed282SShri Abhyankar */ 892b4ed282SShri Abhyankar #undef __FUNCT__ 902b4ed282SShri Abhyankar #define __FUNCT__ "SNESVICheckResidual_Private" 912b4ed282SShri Abhyankar PetscErrorCode SNESVICheckResidual_Private(SNES snes,Mat A,Vec F,Vec X,Vec W1,Vec W2) 922b4ed282SShri Abhyankar { 932b4ed282SShri Abhyankar PetscReal a1,a2; 942b4ed282SShri Abhyankar PetscErrorCode ierr; 95ace3abfcSBarry Smith PetscBool hastranspose; 962b4ed282SShri Abhyankar 972b4ed282SShri Abhyankar PetscFunctionBegin; 982b4ed282SShri Abhyankar ierr = MatHasOperation(A,MATOP_MULT_TRANSPOSE,&hastranspose);CHKERRQ(ierr); 992b4ed282SShri Abhyankar if (hastranspose) { 1002b4ed282SShri Abhyankar ierr = MatMult(A,X,W1);CHKERRQ(ierr); 1012b4ed282SShri Abhyankar ierr = VecAXPY(W1,-1.0,F);CHKERRQ(ierr); 1022b4ed282SShri Abhyankar 1032b4ed282SShri Abhyankar /* Compute || J^T W|| */ 1042b4ed282SShri Abhyankar ierr = MatMultTranspose(A,W1,W2);CHKERRQ(ierr); 1052b4ed282SShri Abhyankar ierr = VecNorm(W1,NORM_2,&a1);CHKERRQ(ierr); 1062b4ed282SShri Abhyankar ierr = VecNorm(W2,NORM_2,&a2);CHKERRQ(ierr); 1072b4ed282SShri Abhyankar if (a1 != 0.0) { 1082b4ed282SShri Abhyankar ierr = PetscInfo1(snes,"||J^T(F-Ax)||/||F-AX|| %G near zero implies inconsistent rhs\n",a2/a1);CHKERRQ(ierr); 1092b4ed282SShri Abhyankar } 1102b4ed282SShri Abhyankar } 1112b4ed282SShri Abhyankar PetscFunctionReturn(0); 1122b4ed282SShri Abhyankar } 1132b4ed282SShri Abhyankar 1142b4ed282SShri Abhyankar /* 1152b4ed282SShri Abhyankar SNESDefaultConverged_VI - Checks the convergence of the semismooth newton algorithm. 1162b4ed282SShri Abhyankar 1172b4ed282SShri Abhyankar Notes: 1182b4ed282SShri Abhyankar The convergence criterion currently implemented is 1192b4ed282SShri Abhyankar merit < abstol 1202b4ed282SShri Abhyankar merit < rtol*merit_initial 1212b4ed282SShri Abhyankar */ 1222b4ed282SShri Abhyankar #undef __FUNCT__ 1232b4ed282SShri Abhyankar #define __FUNCT__ "SNESDefaultConverged_VI" 1247fe79bc4SShri Abhyankar PetscErrorCode SNESDefaultConverged_VI(SNES snes,PetscInt it,PetscReal xnorm,PetscReal gradnorm,PetscReal fnorm,SNESConvergedReason *reason,void *dummy) 1252b4ed282SShri Abhyankar { 1262b4ed282SShri Abhyankar PetscErrorCode ierr; 1272b4ed282SShri Abhyankar 1282b4ed282SShri Abhyankar PetscFunctionBegin; 1292b4ed282SShri Abhyankar PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 1302b4ed282SShri Abhyankar PetscValidPointer(reason,6); 1312b4ed282SShri Abhyankar 1322b4ed282SShri Abhyankar *reason = SNES_CONVERGED_ITERATING; 1332b4ed282SShri Abhyankar 1342b4ed282SShri Abhyankar if (!it) { 1352b4ed282SShri Abhyankar /* set parameter for default relative tolerance convergence test */ 1367fe79bc4SShri Abhyankar snes->ttol = fnorm*snes->rtol; 1372b4ed282SShri Abhyankar } 1387fe79bc4SShri Abhyankar if (fnorm != fnorm) { 1392b4ed282SShri Abhyankar ierr = PetscInfo(snes,"Failed to converged, function norm is NaN\n");CHKERRQ(ierr); 1402b4ed282SShri Abhyankar *reason = SNES_DIVERGED_FNORM_NAN; 1417fe79bc4SShri Abhyankar } else if (fnorm < snes->abstol) { 1427fe79bc4SShri Abhyankar ierr = PetscInfo2(snes,"Converged due to function norm %G < %G\n",fnorm,snes->abstol);CHKERRQ(ierr); 1432b4ed282SShri Abhyankar *reason = SNES_CONVERGED_FNORM_ABS; 1442b4ed282SShri Abhyankar } else if (snes->nfuncs >= snes->max_funcs) { 1452b4ed282SShri Abhyankar ierr = PetscInfo2(snes,"Exceeded maximum number of function evaluations: %D > %D\n",snes->nfuncs,snes->max_funcs);CHKERRQ(ierr); 1462b4ed282SShri Abhyankar *reason = SNES_DIVERGED_FUNCTION_COUNT; 1472b4ed282SShri Abhyankar } 1482b4ed282SShri Abhyankar 1492b4ed282SShri Abhyankar if (it && !*reason) { 1507fe79bc4SShri Abhyankar if (fnorm < snes->ttol) { 1517fe79bc4SShri Abhyankar ierr = PetscInfo2(snes,"Converged due to function norm %G < %G (relative tolerance)\n",fnorm,snes->ttol);CHKERRQ(ierr); 1522b4ed282SShri Abhyankar *reason = SNES_CONVERGED_FNORM_RELATIVE; 1532b4ed282SShri Abhyankar } 1542b4ed282SShri Abhyankar } 1552b4ed282SShri Abhyankar PetscFunctionReturn(0); 1562b4ed282SShri Abhyankar } 1572b4ed282SShri Abhyankar 1582b4ed282SShri Abhyankar /* 1592b4ed282SShri Abhyankar SNESVIComputeMeritFunction - Evaluates the merit function for the mixed complementarity problem. 1602b4ed282SShri Abhyankar 1612b4ed282SShri Abhyankar Input Parameter: 1622b4ed282SShri Abhyankar . phi - the semismooth function 1632b4ed282SShri Abhyankar 1642b4ed282SShri Abhyankar Output Parameter: 1652b4ed282SShri Abhyankar . merit - the merit function 1662b4ed282SShri Abhyankar . phinorm - ||phi|| 1672b4ed282SShri Abhyankar 1682b4ed282SShri Abhyankar Notes: 1692b4ed282SShri Abhyankar The merit function for the mixed complementarity problem is defined as 1702b4ed282SShri Abhyankar merit = 0.5*phi^T*phi 1712b4ed282SShri Abhyankar */ 1722b4ed282SShri Abhyankar #undef __FUNCT__ 1732b4ed282SShri Abhyankar #define __FUNCT__ "SNESVIComputeMeritFunction" 1742b4ed282SShri Abhyankar static PetscErrorCode SNESVIComputeMeritFunction(Vec phi, PetscReal* merit,PetscReal* phinorm) 1752b4ed282SShri Abhyankar { 1762b4ed282SShri Abhyankar PetscErrorCode ierr; 1772b4ed282SShri Abhyankar 1782b4ed282SShri Abhyankar PetscFunctionBegin; 1795f48b12bSBarry Smith ierr = VecNormBegin(phi,NORM_2,phinorm);CHKERRQ(ierr); 1805f48b12bSBarry Smith ierr = VecNormEnd(phi,NORM_2,phinorm);CHKERRQ(ierr); 1812b4ed282SShri Abhyankar 1822b4ed282SShri Abhyankar *merit = 0.5*(*phinorm)*(*phinorm); 1832b4ed282SShri Abhyankar PetscFunctionReturn(0); 1842b4ed282SShri Abhyankar } 1852b4ed282SShri Abhyankar 1867f6f51e9SSatish Balay PETSC_STATIC_INLINE PetscScalar Phi(PetscScalar a,PetscScalar b) 1874c21c6cdSBarry Smith { 1884c21c6cdSBarry Smith return a + b - sqrt(a*a + b*b); 1894c21c6cdSBarry Smith } 1904c21c6cdSBarry Smith 1917f6f51e9SSatish Balay PETSC_STATIC_INLINE PetscScalar DPhi(PetscScalar a,PetscScalar b) 1924c21c6cdSBarry Smith { 1935559b345SBarry Smith if ((PetscAbsScalar(a) >= 1.e-6) || (PetscAbsScalar(b) >= 1.e-6)) return 1.0 - a/ sqrt(a*a + b*b); 1945559b345SBarry Smith else return .5; 1954c21c6cdSBarry Smith } 1964c21c6cdSBarry Smith 1972b4ed282SShri Abhyankar /* 1981f79c099SShri Abhyankar SNESVIComputeFunction - Reformulates a system of nonlinear equations in mixed complementarity form to a system of nonlinear equations in semismooth form. 1992b4ed282SShri Abhyankar 2002b4ed282SShri Abhyankar Input Parameters: 2012b4ed282SShri Abhyankar . snes - the SNES context 2022b4ed282SShri Abhyankar . x - current iterate 2032b4ed282SShri Abhyankar . functx - user defined function context 2042b4ed282SShri Abhyankar 2052b4ed282SShri Abhyankar Output Parameters: 2062b4ed282SShri Abhyankar . phi - Semismooth function 2072b4ed282SShri Abhyankar 2082b4ed282SShri Abhyankar */ 2092b4ed282SShri Abhyankar #undef __FUNCT__ 2101f79c099SShri Abhyankar #define __FUNCT__ "SNESVIComputeFunction" 2111f79c099SShri Abhyankar static PetscErrorCode SNESVIComputeFunction(SNES snes,Vec X,Vec phi,void* functx) 2122b4ed282SShri Abhyankar { 2132b4ed282SShri Abhyankar PetscErrorCode ierr; 2142b4ed282SShri Abhyankar SNES_VI *vi = (SNES_VI*)snes->data; 2152b4ed282SShri Abhyankar Vec Xl = vi->xl,Xu = vi->xu,F = snes->vec_func; 2164c21c6cdSBarry Smith PetscScalar *phi_arr,*x_arr,*f_arr,*l,*u; 2172b4ed282SShri Abhyankar PetscInt i,nlocal; 2182b4ed282SShri Abhyankar 2192b4ed282SShri Abhyankar PetscFunctionBegin; 2202b4ed282SShri Abhyankar ierr = (*vi->computeuserfunction)(snes,X,F,functx);CHKERRQ(ierr); 2212b4ed282SShri Abhyankar ierr = VecGetLocalSize(X,&nlocal);CHKERRQ(ierr); 2222b4ed282SShri Abhyankar ierr = VecGetArray(X,&x_arr);CHKERRQ(ierr); 2232b4ed282SShri Abhyankar ierr = VecGetArray(F,&f_arr);CHKERRQ(ierr); 2242b4ed282SShri Abhyankar ierr = VecGetArray(Xl,&l);CHKERRQ(ierr); 2252b4ed282SShri Abhyankar ierr = VecGetArray(Xu,&u);CHKERRQ(ierr); 2262b4ed282SShri Abhyankar ierr = VecGetArray(phi,&phi_arr);CHKERRQ(ierr); 2272b4ed282SShri Abhyankar 2282b4ed282SShri Abhyankar for (i=0;i < nlocal;i++) { 2295559b345SBarry Smith if ((l[i] <= PETSC_VI_NINF) && (u[i] >= PETSC_VI_INF)) { /* no constraints on variable */ 2304c21c6cdSBarry Smith phi_arr[i] = f_arr[i]; 2315559b345SBarry Smith } else if (l[i] <= PETSC_VI_NINF) { /* upper bound on variable only */ 2324c21c6cdSBarry Smith phi_arr[i] = -Phi(u[i] - x_arr[i],-f_arr[i]); 2335559b345SBarry Smith } else if (u[i] >= PETSC_VI_INF) { /* lower bound on variable only */ 2344c21c6cdSBarry Smith phi_arr[i] = Phi(x_arr[i] - l[i],f_arr[i]); 2355559b345SBarry Smith } else if (l[i] == u[i]) { 2362b4ed282SShri Abhyankar phi_arr[i] = l[i] - x_arr[i]; 2375559b345SBarry Smith } else { /* both bounds on variable */ 2384c21c6cdSBarry Smith phi_arr[i] = Phi(x_arr[i] - l[i],-Phi(u[i] - x_arr[i],-f_arr[i])); 2392b4ed282SShri Abhyankar } 2402b4ed282SShri Abhyankar } 2412b4ed282SShri Abhyankar 2422b4ed282SShri Abhyankar ierr = VecRestoreArray(X,&x_arr);CHKERRQ(ierr); 2432b4ed282SShri Abhyankar ierr = VecRestoreArray(F,&f_arr);CHKERRQ(ierr); 2442b4ed282SShri Abhyankar ierr = VecRestoreArray(Xl,&l);CHKERRQ(ierr); 2452b4ed282SShri Abhyankar ierr = VecRestoreArray(Xu,&u);CHKERRQ(ierr); 2462b4ed282SShri Abhyankar ierr = VecRestoreArray(phi,&phi_arr);CHKERRQ(ierr); 2472b4ed282SShri Abhyankar PetscFunctionReturn(0); 2482b4ed282SShri Abhyankar } 2492b4ed282SShri Abhyankar 2502b4ed282SShri Abhyankar /* 251a79edbefSShri Abhyankar SNESVIComputeBsubdifferentialVectors - Computes the diagonal shift (Da) and row scaling (Db) vectors needed for the 252a79edbefSShri Abhyankar the semismooth jacobian. 2532b4ed282SShri Abhyankar */ 2542b4ed282SShri Abhyankar #undef __FUNCT__ 255a79edbefSShri Abhyankar #define __FUNCT__ "SNESVIComputeBsubdifferentialVectors" 256a79edbefSShri Abhyankar PetscErrorCode SNESVIComputeBsubdifferentialVectors(SNES snes,Vec X,Vec F,Mat jac,Vec Da,Vec Db) 2572b4ed282SShri Abhyankar { 2582b4ed282SShri Abhyankar PetscErrorCode ierr; 2592b4ed282SShri Abhyankar SNES_VI *vi = (SNES_VI*)snes->data; 2604c21c6cdSBarry Smith PetscScalar *l,*u,*x,*f,*da,*db,da1,da2,db1,db2; 2612b4ed282SShri Abhyankar PetscInt i,nlocal; 2622b4ed282SShri Abhyankar 2632b4ed282SShri Abhyankar PetscFunctionBegin; 2642b4ed282SShri Abhyankar 2652b4ed282SShri Abhyankar ierr = VecGetArray(X,&x);CHKERRQ(ierr); 2662b4ed282SShri Abhyankar ierr = VecGetArray(F,&f);CHKERRQ(ierr); 2672b4ed282SShri Abhyankar ierr = VecGetArray(vi->xl,&l);CHKERRQ(ierr); 2682b4ed282SShri Abhyankar ierr = VecGetArray(vi->xu,&u);CHKERRQ(ierr); 269a79edbefSShri Abhyankar ierr = VecGetArray(Da,&da);CHKERRQ(ierr); 270a79edbefSShri Abhyankar ierr = VecGetArray(Db,&db);CHKERRQ(ierr); 2712b4ed282SShri Abhyankar ierr = VecGetLocalSize(X,&nlocal);CHKERRQ(ierr); 2724c21c6cdSBarry Smith 2732b4ed282SShri Abhyankar for (i=0;i< nlocal;i++) { 2745559b345SBarry Smith if ((l[i] <= PETSC_VI_NINF) && (u[i] >= PETSC_VI_INF)) {/* no constraints on variable */ 2754c21c6cdSBarry Smith da[i] = 0; 2762b4ed282SShri Abhyankar db[i] = 1; 2775559b345SBarry Smith } else if (l[i] <= PETSC_VI_NINF) { /* upper bound on variable only */ 2784c21c6cdSBarry Smith da[i] = DPhi(u[i] - x[i], -f[i]); 2794c21c6cdSBarry Smith db[i] = DPhi(-f[i],u[i] - x[i]); 2805559b345SBarry Smith } else if (u[i] >= PETSC_VI_INF) { /* lower bound on variable only */ 2815559b345SBarry Smith da[i] = DPhi(x[i] - l[i], f[i]); 2825559b345SBarry Smith db[i] = DPhi(f[i],x[i] - l[i]); 2835559b345SBarry Smith } else if (l[i] == u[i]) { /* fixed variable */ 2844c21c6cdSBarry Smith da[i] = 1; 2852b4ed282SShri Abhyankar db[i] = 0; 2865559b345SBarry Smith } else { /* upper and lower bounds on variable */ 2874c21c6cdSBarry Smith da1 = DPhi(x[i] - l[i], -Phi(u[i] - x[i], -f[i])); 2884c21c6cdSBarry Smith db1 = DPhi(-Phi(u[i] - x[i], -f[i]),x[i] - l[i]); 2894c21c6cdSBarry Smith da2 = DPhi(u[i] - x[i], -f[i]); 2904c21c6cdSBarry Smith db2 = DPhi(-f[i],u[i] - x[i]); 2914c21c6cdSBarry Smith da[i] = da1 + db1*da2; 2924c21c6cdSBarry Smith db[i] = db1*db2; 2932b4ed282SShri Abhyankar } 2942b4ed282SShri Abhyankar } 2955559b345SBarry Smith 2962b4ed282SShri Abhyankar ierr = VecRestoreArray(X,&x);CHKERRQ(ierr); 2972b4ed282SShri Abhyankar ierr = VecRestoreArray(F,&f);CHKERRQ(ierr); 2982b4ed282SShri Abhyankar ierr = VecRestoreArray(vi->xl,&l);CHKERRQ(ierr); 2992b4ed282SShri Abhyankar ierr = VecRestoreArray(vi->xu,&u);CHKERRQ(ierr); 300a79edbefSShri Abhyankar ierr = VecRestoreArray(Da,&da);CHKERRQ(ierr); 301a79edbefSShri Abhyankar ierr = VecRestoreArray(Db,&db);CHKERRQ(ierr); 302a79edbefSShri Abhyankar PetscFunctionReturn(0); 303a79edbefSShri Abhyankar } 304a79edbefSShri Abhyankar 305a79edbefSShri Abhyankar /* 306a79edbefSShri Abhyankar SNESVIComputeJacobian - Computes the jacobian of the semismooth function.The Jacobian for the semismooth function is an element of the B-subdifferential of the Fischer-Burmeister function for complementarity problems. 307a79edbefSShri Abhyankar 308a79edbefSShri Abhyankar Input Parameters: 309a79edbefSShri Abhyankar . Da - Diagonal shift vector for the semismooth jacobian. 310a79edbefSShri Abhyankar . Db - Row scaling vector for the semismooth jacobian. 311a79edbefSShri Abhyankar 312a79edbefSShri Abhyankar Output Parameters: 313a79edbefSShri Abhyankar . jac - semismooth jacobian 314a79edbefSShri Abhyankar . jac_pre - optional preconditioning matrix 315a79edbefSShri Abhyankar 316a79edbefSShri Abhyankar Notes: 317a79edbefSShri Abhyankar The semismooth jacobian matrix is given by 318a79edbefSShri Abhyankar jac = Da + Db*jacfun 319a79edbefSShri Abhyankar where Db is the row scaling matrix stored as a vector, 320a79edbefSShri Abhyankar Da is the diagonal perturbation matrix stored as a vector 321a79edbefSShri Abhyankar and jacfun is the jacobian of the original nonlinear function. 322a79edbefSShri Abhyankar */ 323a79edbefSShri Abhyankar #undef __FUNCT__ 324a79edbefSShri Abhyankar #define __FUNCT__ "SNESVIComputeJacobian" 325a79edbefSShri Abhyankar PetscErrorCode SNESVIComputeJacobian(Mat jac, Mat jac_pre,Vec Da, Vec Db) 326a79edbefSShri Abhyankar { 327a79edbefSShri Abhyankar PetscErrorCode ierr; 328a79edbefSShri Abhyankar 3292b4ed282SShri Abhyankar /* Do row scaling and add diagonal perturbation */ 330a79edbefSShri Abhyankar ierr = MatDiagonalScale(jac,Db,PETSC_NULL);CHKERRQ(ierr); 331a79edbefSShri Abhyankar ierr = MatDiagonalSet(jac,Da,ADD_VALUES);CHKERRQ(ierr); 332a79edbefSShri Abhyankar if (jac != jac_pre) { /* If jac and jac_pre are different */ 333a79edbefSShri Abhyankar ierr = MatDiagonalScale(jac_pre,Db,PETSC_NULL); 334a79edbefSShri Abhyankar ierr = MatDiagonalSet(jac_pre,Da,ADD_VALUES);CHKERRQ(ierr); 3352b4ed282SShri Abhyankar } 3362b4ed282SShri Abhyankar PetscFunctionReturn(0); 3372b4ed282SShri Abhyankar } 3382b4ed282SShri Abhyankar 3392b4ed282SShri Abhyankar /* 340ee657d29SShri Abhyankar SNESVIComputeMeritFunctionGradient - Computes the gradient of the merit function psi. 341ee657d29SShri Abhyankar 342ee657d29SShri Abhyankar Input Parameters: 343ee657d29SShri Abhyankar phi - semismooth function. 344ee657d29SShri Abhyankar H - semismooth jacobian 345ee657d29SShri Abhyankar 346ee657d29SShri Abhyankar Output Parameters: 347ee657d29SShri Abhyankar dpsi - merit function gradient 348ee657d29SShri Abhyankar 349ee657d29SShri Abhyankar Notes: 350ee657d29SShri Abhyankar The merit function gradient is computed as follows 351ee657d29SShri Abhyankar dpsi = H^T*phi 352ee657d29SShri Abhyankar */ 353ee657d29SShri Abhyankar #undef __FUNCT__ 354ee657d29SShri Abhyankar #define __FUNCT__ "SNESVIComputeMeritFunctionGradient" 355ee657d29SShri Abhyankar PetscErrorCode SNESVIComputeMeritFunctionGradient(Mat H, Vec phi, Vec dpsi) 356ee657d29SShri Abhyankar { 357ee657d29SShri Abhyankar PetscErrorCode ierr; 358ee657d29SShri Abhyankar 359ee657d29SShri Abhyankar PetscFunctionBegin; 3605f48b12bSBarry Smith ierr = MatMultTranspose(H,phi,dpsi);CHKERRQ(ierr); 361ee657d29SShri Abhyankar PetscFunctionReturn(0); 362ee657d29SShri Abhyankar } 363ee657d29SShri Abhyankar 364c1a5e521SShri Abhyankar /* -------------------------------------------------------------------------- */ 365c1a5e521SShri Abhyankar /* 366c1a5e521SShri Abhyankar SNESVIProjectOntoBounds - Projects X onto the feasible region so that Xl[i] <= X[i] <= Xu[i] for i = 1...n. 367c1a5e521SShri Abhyankar 368c1a5e521SShri Abhyankar Input Parameters: 369c1a5e521SShri Abhyankar . SNES - nonlinear solver context 370c1a5e521SShri Abhyankar 371c1a5e521SShri Abhyankar Output Parameters: 372c1a5e521SShri Abhyankar . X - Bound projected X 373c1a5e521SShri Abhyankar 374c1a5e521SShri Abhyankar */ 375c1a5e521SShri Abhyankar 376c1a5e521SShri Abhyankar #undef __FUNCT__ 377c1a5e521SShri Abhyankar #define __FUNCT__ "SNESVIProjectOntoBounds" 378c1a5e521SShri Abhyankar PetscErrorCode SNESVIProjectOntoBounds(SNES snes,Vec X) 379c1a5e521SShri Abhyankar { 380c1a5e521SShri Abhyankar PetscErrorCode ierr; 381c1a5e521SShri Abhyankar SNES_VI *vi = (SNES_VI*)snes->data; 382c1a5e521SShri Abhyankar const PetscScalar *xl,*xu; 383c1a5e521SShri Abhyankar PetscScalar *x; 384c1a5e521SShri Abhyankar PetscInt i,n; 385c1a5e521SShri Abhyankar 386c1a5e521SShri Abhyankar PetscFunctionBegin; 387c1a5e521SShri Abhyankar ierr = VecGetLocalSize(X,&n);CHKERRQ(ierr); 388c1a5e521SShri Abhyankar ierr = VecGetArray(X,&x);CHKERRQ(ierr); 389c1a5e521SShri Abhyankar ierr = VecGetArrayRead(vi->xl,&xl);CHKERRQ(ierr); 390c1a5e521SShri Abhyankar ierr = VecGetArrayRead(vi->xu,&xu);CHKERRQ(ierr); 391c1a5e521SShri Abhyankar 392c1a5e521SShri Abhyankar for(i = 0;i<n;i++) { 393c1a5e521SShri Abhyankar if (x[i] < xl[i]) x[i] = xl[i]; 394c1a5e521SShri Abhyankar else if (x[i] > xu[i]) x[i] = xu[i]; 395c1a5e521SShri Abhyankar } 396c1a5e521SShri Abhyankar ierr = VecRestoreArray(X,&x);CHKERRQ(ierr); 397c1a5e521SShri Abhyankar ierr = VecRestoreArrayRead(vi->xl,&xl);CHKERRQ(ierr); 398c1a5e521SShri Abhyankar ierr = VecRestoreArrayRead(vi->xu,&xu);CHKERRQ(ierr); 399c1a5e521SShri Abhyankar PetscFunctionReturn(0); 400c1a5e521SShri Abhyankar } 401c1a5e521SShri Abhyankar 4022b4ed282SShri Abhyankar /* -------------------------------------------------------------------- 4032b4ed282SShri Abhyankar 4042b4ed282SShri Abhyankar This file implements a semismooth truncated Newton method with a line search, 4052b4ed282SShri Abhyankar for solving a system of nonlinear equations in complementarity form, using the KSP, Vec, 4062b4ed282SShri Abhyankar and Mat interfaces for linear solvers, vectors, and matrices, 4072b4ed282SShri Abhyankar respectively. 4082b4ed282SShri Abhyankar 4092b4ed282SShri Abhyankar The following basic routines are required for each nonlinear solver: 4102b4ed282SShri Abhyankar SNESCreate_XXX() - Creates a nonlinear solver context 4112b4ed282SShri Abhyankar SNESSetFromOptions_XXX() - Sets runtime options 4122b4ed282SShri Abhyankar SNESSolve_XXX() - Solves the nonlinear system 4132b4ed282SShri Abhyankar SNESDestroy_XXX() - Destroys the nonlinear solver context 4142b4ed282SShri Abhyankar The suffix "_XXX" denotes a particular implementation, in this case 4152b4ed282SShri Abhyankar we use _VI (e.g., SNESCreate_VI, SNESSolve_VI) for solving 4162b4ed282SShri Abhyankar systems of nonlinear equations with a line search (LS) method. 4172b4ed282SShri Abhyankar These routines are actually called via the common user interface 4182b4ed282SShri Abhyankar routines SNESCreate(), SNESSetFromOptions(), SNESSolve(), and 4192b4ed282SShri Abhyankar SNESDestroy(), so the application code interface remains identical 4202b4ed282SShri Abhyankar for all nonlinear solvers. 4212b4ed282SShri Abhyankar 4222b4ed282SShri Abhyankar Another key routine is: 4232b4ed282SShri Abhyankar SNESSetUp_XXX() - Prepares for the use of a nonlinear solver 4242b4ed282SShri Abhyankar by setting data structures and options. The interface routine SNESSetUp() 4252b4ed282SShri Abhyankar is not usually called directly by the user, but instead is called by 4262b4ed282SShri Abhyankar SNESSolve() if necessary. 4272b4ed282SShri Abhyankar 4282b4ed282SShri Abhyankar Additional basic routines are: 4292b4ed282SShri Abhyankar SNESView_XXX() - Prints details of runtime options that 4302b4ed282SShri Abhyankar have actually been used. 4312b4ed282SShri Abhyankar These are called by application codes via the interface routines 4322b4ed282SShri Abhyankar SNESView(). 4332b4ed282SShri Abhyankar 4342b4ed282SShri Abhyankar The various types of solvers (preconditioners, Krylov subspace methods, 4352b4ed282SShri Abhyankar nonlinear solvers, timesteppers) are all organized similarly, so the 4362b4ed282SShri Abhyankar above description applies to these categories also. 4372b4ed282SShri Abhyankar 4382b4ed282SShri Abhyankar -------------------------------------------------------------------- */ 4392b4ed282SShri Abhyankar /* 44069c03620SShri Abhyankar SNESSolveVI_SS - Solves the complementarity problem with a semismooth Newton 4412b4ed282SShri Abhyankar method using a line search. 4422b4ed282SShri Abhyankar 4432b4ed282SShri Abhyankar Input Parameters: 4442b4ed282SShri Abhyankar . snes - the SNES context 4452b4ed282SShri Abhyankar 4462b4ed282SShri Abhyankar Output Parameter: 4472b4ed282SShri Abhyankar . outits - number of iterations until termination 4482b4ed282SShri Abhyankar 4492b4ed282SShri Abhyankar Application Interface Routine: SNESSolve() 4502b4ed282SShri Abhyankar 4512b4ed282SShri Abhyankar Notes: 4522b4ed282SShri Abhyankar This implements essentially a semismooth Newton method with a 45351defd01SShri Abhyankar line search. The default line search does not do any line seach 45451defd01SShri Abhyankar but rather takes a full newton step. 4552b4ed282SShri Abhyankar */ 4562b4ed282SShri Abhyankar #undef __FUNCT__ 45769c03620SShri Abhyankar #define __FUNCT__ "SNESSolveVI_SS" 45869c03620SShri Abhyankar PetscErrorCode SNESSolveVI_SS(SNES snes) 4592b4ed282SShri Abhyankar { 4602b4ed282SShri Abhyankar SNES_VI *vi = (SNES_VI*)snes->data; 4612b4ed282SShri Abhyankar PetscErrorCode ierr; 4622b4ed282SShri Abhyankar PetscInt maxits,i,lits; 4633b336b49SShri Abhyankar PetscBool lssucceed; 4642b4ed282SShri Abhyankar MatStructure flg = DIFFERENT_NONZERO_PATTERN; 4652b4ed282SShri Abhyankar PetscReal gnorm,xnorm=0,ynorm; 4662b4ed282SShri Abhyankar Vec Y,X,F,G,W; 4672b4ed282SShri Abhyankar KSPConvergedReason kspreason; 4682b4ed282SShri Abhyankar 4692b4ed282SShri Abhyankar PetscFunctionBegin; 4709ce7406fSBarry Smith vi->computeuserfunction = snes->ops->computefunction; 4719ce7406fSBarry Smith snes->ops->computefunction = SNESVIComputeFunction; 4729ce7406fSBarry Smith 4732b4ed282SShri Abhyankar snes->numFailures = 0; 4742b4ed282SShri Abhyankar snes->numLinearSolveFailures = 0; 4752b4ed282SShri Abhyankar snes->reason = SNES_CONVERGED_ITERATING; 4762b4ed282SShri Abhyankar 4772b4ed282SShri Abhyankar maxits = snes->max_its; /* maximum number of iterations */ 4782b4ed282SShri Abhyankar X = snes->vec_sol; /* solution vector */ 4792b4ed282SShri Abhyankar F = snes->vec_func; /* residual vector */ 4802b4ed282SShri Abhyankar Y = snes->work[0]; /* work vectors */ 4812b4ed282SShri Abhyankar G = snes->work[1]; 4822b4ed282SShri Abhyankar W = snes->work[2]; 4832b4ed282SShri Abhyankar 4842b4ed282SShri Abhyankar ierr = PetscObjectTakeAccess(snes);CHKERRQ(ierr); 4852b4ed282SShri Abhyankar snes->iter = 0; 4862b4ed282SShri Abhyankar snes->norm = 0.0; 4872b4ed282SShri Abhyankar ierr = PetscObjectGrantAccess(snes);CHKERRQ(ierr); 4882b4ed282SShri Abhyankar 4897fe79bc4SShri Abhyankar ierr = SNESVIProjectOntoBounds(snes,X);CHKERRQ(ierr); 4902b4ed282SShri Abhyankar ierr = SNESComputeFunction(snes,X,vi->phi);CHKERRQ(ierr); 4912b4ed282SShri Abhyankar if (snes->domainerror) { 4922b4ed282SShri Abhyankar snes->reason = SNES_DIVERGED_FUNCTION_DOMAIN; 4939ce7406fSBarry Smith snes->ops->computefunction = vi->computeuserfunction; 4942b4ed282SShri Abhyankar PetscFunctionReturn(0); 4952b4ed282SShri Abhyankar } 4962b4ed282SShri Abhyankar /* Compute Merit function */ 4972b4ed282SShri Abhyankar ierr = SNESVIComputeMeritFunction(vi->phi,&vi->merit,&vi->phinorm);CHKERRQ(ierr); 4982b4ed282SShri Abhyankar 4992b4ed282SShri Abhyankar ierr = VecNormBegin(X,NORM_2,&xnorm);CHKERRQ(ierr); /* xnorm <- ||x|| */ 5002b4ed282SShri Abhyankar ierr = VecNormEnd(X,NORM_2,&xnorm);CHKERRQ(ierr); 50162cbcd01SMatthew G Knepley if (PetscIsInfOrNanReal(vi->merit)) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FP,"User provided compute function generated a Not-a-Number"); 5022b4ed282SShri Abhyankar 5032b4ed282SShri Abhyankar ierr = PetscObjectTakeAccess(snes);CHKERRQ(ierr); 5042b4ed282SShri Abhyankar snes->norm = vi->phinorm; 5052b4ed282SShri Abhyankar ierr = PetscObjectGrantAccess(snes);CHKERRQ(ierr); 5062b4ed282SShri Abhyankar SNESLogConvHistory(snes,vi->phinorm,0); 5072b4ed282SShri Abhyankar SNESMonitor(snes,0,vi->phinorm); 5082b4ed282SShri Abhyankar 5092b4ed282SShri Abhyankar /* set parameter for default relative tolerance convergence test */ 5102b4ed282SShri Abhyankar snes->ttol = vi->phinorm*snes->rtol; 5112b4ed282SShri Abhyankar /* test convergence */ 5122b4ed282SShri Abhyankar ierr = (*snes->ops->converged)(snes,0,0.0,0.0,vi->phinorm,&snes->reason,snes->cnvP);CHKERRQ(ierr); 5139ce7406fSBarry Smith if (snes->reason) { 5149ce7406fSBarry Smith snes->ops->computefunction = vi->computeuserfunction; 5159ce7406fSBarry Smith PetscFunctionReturn(0); 5169ce7406fSBarry Smith } 5172b4ed282SShri Abhyankar 5182b4ed282SShri Abhyankar for (i=0; i<maxits; i++) { 5192b4ed282SShri Abhyankar 5202b4ed282SShri Abhyankar /* Call general purpose update function */ 5212b4ed282SShri Abhyankar if (snes->ops->update) { 5222b4ed282SShri Abhyankar ierr = (*snes->ops->update)(snes, snes->iter);CHKERRQ(ierr); 5232b4ed282SShri Abhyankar } 5242b4ed282SShri Abhyankar 5252b4ed282SShri Abhyankar /* Solve J Y = Phi, where J is the semismooth jacobian */ 526a79edbefSShri Abhyankar /* Get the nonlinear function jacobian */ 5272b4ed282SShri Abhyankar ierr = SNESComputeJacobian(snes,X,&snes->jacobian,&snes->jacobian_pre,&flg);CHKERRQ(ierr); 528a79edbefSShri Abhyankar /* Get the diagonal shift and row scaling vectors */ 529a79edbefSShri Abhyankar ierr = SNESVIComputeBsubdifferentialVectors(snes,X,F,snes->jacobian,vi->Da,vi->Db);CHKERRQ(ierr); 530a79edbefSShri Abhyankar /* Compute the semismooth jacobian */ 531a79edbefSShri Abhyankar ierr = SNESVIComputeJacobian(snes->jacobian,snes->jacobian_pre,vi->Da,vi->Db);CHKERRQ(ierr); 532ee657d29SShri Abhyankar /* Compute the merit function gradient */ 533ee657d29SShri Abhyankar ierr = SNESVIComputeMeritFunctionGradient(snes->jacobian,vi->phi,vi->dpsi);CHKERRQ(ierr); 5342b4ed282SShri Abhyankar ierr = KSPSetOperators(snes->ksp,snes->jacobian,snes->jacobian_pre,flg);CHKERRQ(ierr); 5352b4ed282SShri Abhyankar ierr = SNES_KSPSolve(snes,snes->ksp,vi->phi,Y);CHKERRQ(ierr); 5362b4ed282SShri Abhyankar ierr = KSPGetConvergedReason(snes->ksp,&kspreason);CHKERRQ(ierr); 5373b336b49SShri Abhyankar 5383b336b49SShri Abhyankar if (kspreason < 0) { 5392b4ed282SShri Abhyankar if (++snes->numLinearSolveFailures >= snes->maxLinearSolveFailures) { 5402b4ed282SShri Abhyankar ierr = PetscInfo2(snes,"iter=%D, number linear solve failures %D greater than current SNES allowed, stopping solve\n",snes->iter,snes->numLinearSolveFailures);CHKERRQ(ierr); 5412b4ed282SShri Abhyankar snes->reason = SNES_DIVERGED_LINEAR_SOLVE; 5422b4ed282SShri Abhyankar break; 5432b4ed282SShri Abhyankar } 5442b4ed282SShri Abhyankar } 5452b4ed282SShri Abhyankar ierr = KSPGetIterationNumber(snes->ksp,&lits);CHKERRQ(ierr); 5462b4ed282SShri Abhyankar snes->linear_its += lits; 5472b4ed282SShri Abhyankar ierr = PetscInfo2(snes,"iter=%D, linear solve iterations=%D\n",snes->iter,lits);CHKERRQ(ierr); 5482b4ed282SShri Abhyankar /* 5492b4ed282SShri Abhyankar if (vi->precheckstep) { 550ace3abfcSBarry Smith PetscBool changed_y = PETSC_FALSE; 5512b4ed282SShri Abhyankar ierr = (*vi->precheckstep)(snes,X,Y,vi->precheck,&changed_y);CHKERRQ(ierr); 5522b4ed282SShri Abhyankar } 5532b4ed282SShri Abhyankar 5542b4ed282SShri Abhyankar if (PetscLogPrintInfo){ 5552b4ed282SShri Abhyankar ierr = SNESVICheckResidual_Private(snes,snes->jacobian,F,Y,G,W);CHKERRQ(ierr); 5562b4ed282SShri Abhyankar } 5572b4ed282SShri Abhyankar */ 5582b4ed282SShri Abhyankar /* Compute a (scaled) negative update in the line search routine: 5592b4ed282SShri Abhyankar Y <- X - lambda*Y 5602b4ed282SShri Abhyankar and evaluate G = function(Y) (depends on the line search). 5612b4ed282SShri Abhyankar */ 5622b4ed282SShri Abhyankar ierr = VecCopy(Y,snes->vec_sol_update);CHKERRQ(ierr); 5632b4ed282SShri Abhyankar ynorm = 1; gnorm = vi->phinorm; 5642b4ed282SShri Abhyankar ierr = (*vi->LineSearch)(snes,vi->lsP,X,vi->phi,G,Y,W,vi->phinorm,xnorm,&ynorm,&gnorm,&lssucceed);CHKERRQ(ierr); 5652b4ed282SShri Abhyankar ierr = PetscInfo4(snes,"fnorm=%18.16e, gnorm=%18.16e, ynorm=%18.16e, lssucceed=%d\n",vi->phinorm,gnorm,ynorm,(int)lssucceed);CHKERRQ(ierr); 5662b4ed282SShri Abhyankar if (snes->reason == SNES_DIVERGED_FUNCTION_COUNT) break; 5672b4ed282SShri Abhyankar if (snes->domainerror) { 5682b4ed282SShri Abhyankar snes->reason = SNES_DIVERGED_FUNCTION_DOMAIN; 5699ce7406fSBarry Smith snes->ops->computefunction = vi->computeuserfunction; 5702b4ed282SShri Abhyankar PetscFunctionReturn(0); 5712b4ed282SShri Abhyankar } 5722b4ed282SShri Abhyankar if (!lssucceed) { 5732b4ed282SShri Abhyankar if (++snes->numFailures >= snes->maxFailures) { 574ace3abfcSBarry Smith PetscBool ismin; 5752b4ed282SShri Abhyankar snes->reason = SNES_DIVERGED_LINE_SEARCH; 5762b4ed282SShri Abhyankar ierr = SNESVICheckLocalMin_Private(snes,snes->jacobian,G,W,gnorm,&ismin);CHKERRQ(ierr); 5772b4ed282SShri Abhyankar if (ismin) snes->reason = SNES_DIVERGED_LOCAL_MIN; 5782b4ed282SShri Abhyankar break; 5792b4ed282SShri Abhyankar } 5802b4ed282SShri Abhyankar } 5812b4ed282SShri Abhyankar /* Update function and solution vectors */ 5822b4ed282SShri Abhyankar vi->phinorm = gnorm; 5832b4ed282SShri Abhyankar vi->merit = 0.5*vi->phinorm*vi->phinorm; 5842b4ed282SShri Abhyankar ierr = VecCopy(G,vi->phi);CHKERRQ(ierr); 5852b4ed282SShri Abhyankar ierr = VecCopy(W,X);CHKERRQ(ierr); 5862b4ed282SShri Abhyankar /* Monitor convergence */ 5872b4ed282SShri Abhyankar ierr = PetscObjectTakeAccess(snes);CHKERRQ(ierr); 5882b4ed282SShri Abhyankar snes->iter = i+1; 5892b4ed282SShri Abhyankar snes->norm = vi->phinorm; 5902b4ed282SShri Abhyankar ierr = PetscObjectGrantAccess(snes);CHKERRQ(ierr); 5912b4ed282SShri Abhyankar SNESLogConvHistory(snes,snes->norm,lits); 5922b4ed282SShri Abhyankar SNESMonitor(snes,snes->iter,snes->norm); 5932b4ed282SShri Abhyankar /* Test for convergence, xnorm = || X || */ 5942b4ed282SShri Abhyankar if (snes->ops->converged != SNESSkipConverged) { ierr = VecNorm(X,NORM_2,&xnorm);CHKERRQ(ierr); } 5952b4ed282SShri Abhyankar ierr = (*snes->ops->converged)(snes,snes->iter,xnorm,ynorm,vi->phinorm,&snes->reason,snes->cnvP);CHKERRQ(ierr); 5962b4ed282SShri Abhyankar if (snes->reason) break; 5972b4ed282SShri Abhyankar } 5982b4ed282SShri Abhyankar if (i == maxits) { 5992b4ed282SShri Abhyankar ierr = PetscInfo1(snes,"Maximum number of iterations has been reached: %D\n",maxits);CHKERRQ(ierr); 6002b4ed282SShri Abhyankar if(!snes->reason) snes->reason = SNES_DIVERGED_MAX_IT; 6012b4ed282SShri Abhyankar } 6029ce7406fSBarry Smith snes->ops->computefunction = vi->computeuserfunction; 6032b4ed282SShri Abhyankar PetscFunctionReturn(0); 6042b4ed282SShri Abhyankar } 60569c03620SShri Abhyankar 60669c03620SShri Abhyankar #undef __FUNCT__ 607693ddf92SShri Abhyankar #define __FUNCT__ "SNESVIGetActiveSetIS" 608693ddf92SShri Abhyankar /* 609693ddf92SShri Abhyankar SNESVIGetActiveSetIndices - Gets the global indices for the active set variables 610693ddf92SShri Abhyankar 611693ddf92SShri Abhyankar Input parameter 612693ddf92SShri Abhyankar . snes - the SNES context 613693ddf92SShri Abhyankar . X - the snes solution vector 614693ddf92SShri Abhyankar . F - the nonlinear function vector 615693ddf92SShri Abhyankar 616693ddf92SShri Abhyankar Output parameter 617693ddf92SShri Abhyankar . ISact - active set index set 618693ddf92SShri Abhyankar */ 619693ddf92SShri Abhyankar PetscErrorCode SNESVIGetActiveSetIS(SNES snes,Vec X,Vec F,IS* ISact) 620d950fb63SShri Abhyankar { 621d950fb63SShri Abhyankar PetscErrorCode ierr; 622693ddf92SShri Abhyankar SNES_VI *vi = (SNES_VI*)snes->data; 623693ddf92SShri Abhyankar Vec Xl=vi->xl,Xu=vi->xu; 624693ddf92SShri Abhyankar const PetscScalar *x,*f,*xl,*xu; 625693ddf92SShri Abhyankar PetscInt *idx_act,i,nlocal,nloc_isact=0,ilow,ihigh,i1=0; 626d950fb63SShri Abhyankar 627d950fb63SShri Abhyankar PetscFunctionBegin; 628d950fb63SShri Abhyankar ierr = VecGetLocalSize(X,&nlocal);CHKERRQ(ierr); 629d950fb63SShri Abhyankar ierr = VecGetOwnershipRange(X,&ilow,&ihigh);CHKERRQ(ierr); 630fe835674SShri Abhyankar ierr = VecGetArrayRead(X,&x);CHKERRQ(ierr); 631fe835674SShri Abhyankar ierr = VecGetArrayRead(Xl,&xl);CHKERRQ(ierr); 632fe835674SShri Abhyankar ierr = VecGetArrayRead(Xu,&xu);CHKERRQ(ierr); 633fe835674SShri Abhyankar ierr = VecGetArrayRead(F,&f);CHKERRQ(ierr); 634693ddf92SShri Abhyankar /* Compute active set size */ 635d950fb63SShri Abhyankar for (i=0; i < nlocal;i++) { 636693ddf92SShri Abhyankar if (!((x[i] > xl[i] + 1.e-8 || (f[i] < 0.0)) && ((x[i] < xu[i] - 1.e-8) || f[i] > 0.0))) nloc_isact++; 637d950fb63SShri Abhyankar } 638693ddf92SShri Abhyankar 639d950fb63SShri Abhyankar ierr = PetscMalloc(nloc_isact*sizeof(PetscInt),&idx_act);CHKERRQ(ierr); 640d950fb63SShri Abhyankar 641693ddf92SShri Abhyankar /* Set active set indices */ 642d950fb63SShri Abhyankar for(i=0; i < nlocal; i++) { 643693ddf92SShri Abhyankar if (!((x[i] > xl[i] + 1.e-8 || (f[i] < 0.0)) && ((x[i] < xu[i] - 1.e-8) || f[i] > 0.0))) idx_act[i1++] = ilow+i; 644d950fb63SShri Abhyankar } 645d950fb63SShri Abhyankar 646693ddf92SShri Abhyankar /* Create active set IS */ 64762298a1eSBarry Smith ierr = ISCreateGeneral(((PetscObject)snes)->comm,nloc_isact,idx_act,PETSC_OWN_POINTER,ISact);CHKERRQ(ierr); 648d950fb63SShri Abhyankar 649fe835674SShri Abhyankar ierr = VecRestoreArrayRead(X,&x);CHKERRQ(ierr); 650fe835674SShri Abhyankar ierr = VecRestoreArrayRead(Xl,&xl);CHKERRQ(ierr); 651fe835674SShri Abhyankar ierr = VecRestoreArrayRead(Xu,&xu);CHKERRQ(ierr); 652fe835674SShri Abhyankar ierr = VecRestoreArrayRead(F,&f);CHKERRQ(ierr); 653d950fb63SShri Abhyankar PetscFunctionReturn(0); 654d950fb63SShri Abhyankar } 655d950fb63SShri Abhyankar 656693ddf92SShri Abhyankar #undef __FUNCT__ 657693ddf92SShri Abhyankar #define __FUNCT__ "SNESVICreateIndexSets_RS" 658693ddf92SShri Abhyankar PetscErrorCode SNESVICreateIndexSets_RS(SNES snes,Vec X,Vec F,IS* ISact,IS* ISinact) 659693ddf92SShri Abhyankar { 660693ddf92SShri Abhyankar PetscErrorCode ierr; 661693ddf92SShri Abhyankar 662693ddf92SShri Abhyankar PetscFunctionBegin; 663693ddf92SShri Abhyankar ierr = SNESVIGetActiveSetIS(snes,X,F,ISact);CHKERRQ(ierr); 664693ddf92SShri Abhyankar ierr = ISComplement(*ISact,X->map->rstart,X->map->rend,ISinact);CHKERRQ(ierr); 665693ddf92SShri Abhyankar PetscFunctionReturn(0); 666693ddf92SShri Abhyankar } 667693ddf92SShri Abhyankar 668dbd914b8SShri Abhyankar /* Create active and inactive set vectors. The local size of this vector is set and petsc computes the global size */ 669dbd914b8SShri Abhyankar #undef __FUNCT__ 670fe835674SShri Abhyankar #define __FUNCT__ "SNESVICreateSubVectors" 671fe835674SShri Abhyankar PetscErrorCode SNESVICreateSubVectors(SNES snes,PetscInt n,Vec* newv) 672dbd914b8SShri Abhyankar { 673dbd914b8SShri Abhyankar PetscErrorCode ierr; 674dbd914b8SShri Abhyankar Vec v; 675dbd914b8SShri Abhyankar 676dbd914b8SShri Abhyankar PetscFunctionBegin; 677dbd914b8SShri Abhyankar ierr = VecCreate(((PetscObject)snes)->comm,&v);CHKERRQ(ierr); 678dbd914b8SShri Abhyankar ierr = VecSetSizes(v,n,PETSC_DECIDE);CHKERRQ(ierr); 679dbd914b8SShri Abhyankar ierr = VecSetFromOptions(v);CHKERRQ(ierr); 680dbd914b8SShri Abhyankar *newv = v; 681dbd914b8SShri Abhyankar 682dbd914b8SShri Abhyankar PetscFunctionReturn(0); 683dbd914b8SShri Abhyankar } 684dbd914b8SShri Abhyankar 685732bb160SShri Abhyankar /* Resets the snes PC and KSP when the active set sizes change */ 686732bb160SShri Abhyankar #undef __FUNCT__ 687732bb160SShri Abhyankar #define __FUNCT__ "SNESVIResetPCandKSP" 688732bb160SShri Abhyankar PetscErrorCode SNESVIResetPCandKSP(SNES snes,Mat Amat,Mat Pmat) 689732bb160SShri Abhyankar { 690732bb160SShri Abhyankar PetscErrorCode ierr; 691732bb160SShri Abhyankar KSP kspnew,snesksp; 692732bb160SShri Abhyankar PC pcnew; 693732bb160SShri Abhyankar const MatSolverPackage stype; 694dbd914b8SShri Abhyankar 695732bb160SShri Abhyankar PetscFunctionBegin; 696732bb160SShri Abhyankar /* The active and inactive set sizes have changed so need to create a new snes->ksp object */ 697732bb160SShri Abhyankar ierr = SNESGetKSP(snes,&snesksp);CHKERRQ(ierr); 698732bb160SShri Abhyankar ierr = KSPCreate(((PetscObject)snes)->comm,&kspnew);CHKERRQ(ierr); 699732bb160SShri Abhyankar /* Copy over snes->ksp info */ 700732bb160SShri Abhyankar kspnew->pc_side = snesksp->pc_side; 701732bb160SShri Abhyankar kspnew->rtol = snesksp->rtol; 702732bb160SShri Abhyankar kspnew->abstol = snesksp->abstol; 703732bb160SShri Abhyankar kspnew->max_it = snesksp->max_it; 704732bb160SShri Abhyankar ierr = KSPSetType(kspnew,((PetscObject)snesksp)->type_name);CHKERRQ(ierr); 705732bb160SShri Abhyankar ierr = KSPGetPC(kspnew,&pcnew);CHKERRQ(ierr); 706732bb160SShri Abhyankar ierr = PCSetType(kspnew->pc,((PetscObject)snesksp->pc)->type_name);CHKERRQ(ierr); 707732bb160SShri Abhyankar ierr = PCSetOperators(kspnew->pc,Amat,Pmat,DIFFERENT_NONZERO_PATTERN);CHKERRQ(ierr); 708732bb160SShri Abhyankar ierr = PCFactorGetMatSolverPackage(snesksp->pc,&stype);CHKERRQ(ierr); 709732bb160SShri Abhyankar ierr = PCFactorSetMatSolverPackage(kspnew->pc,stype);CHKERRQ(ierr); 7106bf464f9SBarry Smith ierr = KSPDestroy(&snesksp);CHKERRQ(ierr); 711732bb160SShri Abhyankar snes->ksp = kspnew; 712732bb160SShri Abhyankar ierr = PetscLogObjectParent(snes,kspnew);CHKERRQ(ierr); 713732bb160SShri Abhyankar ierr = KSPSetFromOptions(kspnew);CHKERRQ(ierr); 714732bb160SShri Abhyankar PetscFunctionReturn(0); 715732bb160SShri Abhyankar } 71669c03620SShri Abhyankar 71769c03620SShri Abhyankar 718fe835674SShri Abhyankar #undef __FUNCT__ 719fe835674SShri Abhyankar #define __FUNCT__ "SNESVIComputeInactiveSetFnorm" 720fe835674SShri Abhyankar PetscErrorCode SNESVIComputeInactiveSetFnorm(SNES snes,Vec F,Vec X,PetscScalar *fnorm) 721fe835674SShri Abhyankar { 722fe835674SShri Abhyankar PetscErrorCode ierr; 723fe835674SShri Abhyankar SNES_VI *vi = (SNES_VI*)snes->data; 724fe835674SShri Abhyankar const PetscScalar *x,*xl,*xu,*f; 725fe835674SShri Abhyankar PetscInt i,n; 726fe835674SShri Abhyankar PetscReal rnorm; 727fe835674SShri Abhyankar 728fe835674SShri Abhyankar PetscFunctionBegin; 729fe835674SShri Abhyankar ierr = VecGetLocalSize(X,&n);CHKERRQ(ierr); 730fe835674SShri Abhyankar ierr = VecGetArrayRead(vi->xl,&xl);CHKERRQ(ierr); 731fe835674SShri Abhyankar ierr = VecGetArrayRead(vi->xu,&xu);CHKERRQ(ierr); 732fe835674SShri Abhyankar ierr = VecGetArrayRead(X,&x);CHKERRQ(ierr); 733fe835674SShri Abhyankar ierr = VecGetArrayRead(F,&f);CHKERRQ(ierr); 734fe835674SShri Abhyankar rnorm = 0.0; 735fe835674SShri Abhyankar for (i=0; i<n; i++) { 736fe835674SShri Abhyankar if (((x[i] > xl[i] + 1.e-8 || (f[i] < 0.0)) && ((x[i] < xu[i] - 1.e-8) || f[i] > 0.0))) rnorm += f[i]*f[i]; 737fe835674SShri Abhyankar } 738fe835674SShri Abhyankar ierr = VecRestoreArrayRead(F,&f);CHKERRQ(ierr); 739fe835674SShri Abhyankar ierr = VecRestoreArrayRead(vi->xl,&xl);CHKERRQ(ierr); 740fe835674SShri Abhyankar ierr = VecRestoreArrayRead(vi->xu,&xu);CHKERRQ(ierr); 741fe835674SShri Abhyankar ierr = VecRestoreArrayRead(X,&x);CHKERRQ(ierr); 742d9822059SBarry Smith ierr = MPI_Allreduce(&rnorm,fnorm,1,MPIU_REAL,MPIU_SUM,((PetscObject)snes)->comm);CHKERRQ(ierr); 743fe835674SShri Abhyankar *fnorm = sqrt(*fnorm); 744fe835674SShri Abhyankar PetscFunctionReturn(0); 745fe835674SShri Abhyankar } 746fe835674SShri Abhyankar 747fe835674SShri Abhyankar /* Variational Inequality solver using reduce space method. No semismooth algorithm is 748fe835674SShri Abhyankar implemented in this algorithm. It basically identifies the active variables and does 749fe835674SShri Abhyankar a linear solve on the inactive variables. */ 750d950fb63SShri Abhyankar #undef __FUNCT__ 751d950fb63SShri Abhyankar #define __FUNCT__ "SNESSolveVI_RS" 752d950fb63SShri Abhyankar PetscErrorCode SNESSolveVI_RS(SNES snes) 753d950fb63SShri Abhyankar { 754d950fb63SShri Abhyankar SNES_VI *vi = (SNES_VI*)snes->data; 755d950fb63SShri Abhyankar PetscErrorCode ierr; 756abcba341SShri Abhyankar PetscInt maxits,i,lits; 757d950fb63SShri Abhyankar PetscBool lssucceed; 758d950fb63SShri Abhyankar MatStructure flg = DIFFERENT_NONZERO_PATTERN; 759fe835674SShri Abhyankar PetscReal fnorm,gnorm,xnorm=0,ynorm; 760d950fb63SShri Abhyankar Vec Y,X,F,G,W; 761d950fb63SShri Abhyankar KSPConvergedReason kspreason; 762d950fb63SShri Abhyankar 763d950fb63SShri Abhyankar PetscFunctionBegin; 764d950fb63SShri Abhyankar snes->numFailures = 0; 765d950fb63SShri Abhyankar snes->numLinearSolveFailures = 0; 766d950fb63SShri Abhyankar snes->reason = SNES_CONVERGED_ITERATING; 767d950fb63SShri Abhyankar 768d950fb63SShri Abhyankar maxits = snes->max_its; /* maximum number of iterations */ 769d950fb63SShri Abhyankar X = snes->vec_sol; /* solution vector */ 770d950fb63SShri Abhyankar F = snes->vec_func; /* residual vector */ 771d950fb63SShri Abhyankar Y = snes->work[0]; /* work vectors */ 772d950fb63SShri Abhyankar G = snes->work[1]; 773d950fb63SShri Abhyankar W = snes->work[2]; 774d950fb63SShri Abhyankar 775d950fb63SShri Abhyankar ierr = PetscObjectTakeAccess(snes);CHKERRQ(ierr); 776d950fb63SShri Abhyankar snes->iter = 0; 777d950fb63SShri Abhyankar snes->norm = 0.0; 778d950fb63SShri Abhyankar ierr = PetscObjectGrantAccess(snes);CHKERRQ(ierr); 779d950fb63SShri Abhyankar 7807fe79bc4SShri Abhyankar ierr = SNESVIProjectOntoBounds(snes,X);CHKERRQ(ierr); 781fe835674SShri Abhyankar ierr = SNESComputeFunction(snes,X,F);CHKERRQ(ierr); 782d950fb63SShri Abhyankar if (snes->domainerror) { 783d950fb63SShri Abhyankar snes->reason = SNES_DIVERGED_FUNCTION_DOMAIN; 784d950fb63SShri Abhyankar PetscFunctionReturn(0); 785d950fb63SShri Abhyankar } 786fe835674SShri Abhyankar ierr = SNESVIComputeInactiveSetFnorm(snes,F,X,&fnorm);CHKERRQ(ierr); 787d950fb63SShri Abhyankar ierr = VecNormBegin(X,NORM_2,&xnorm);CHKERRQ(ierr); /* xnorm <- ||x|| */ 788d950fb63SShri Abhyankar ierr = VecNormEnd(X,NORM_2,&xnorm);CHKERRQ(ierr); 78962cbcd01SMatthew G Knepley if (PetscIsInfOrNanReal(fnorm)) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FP,"User provided compute function generated a Not-a-Number"); 790d950fb63SShri Abhyankar 791d950fb63SShri Abhyankar ierr = PetscObjectTakeAccess(snes);CHKERRQ(ierr); 792fe835674SShri Abhyankar snes->norm = fnorm; 793d950fb63SShri Abhyankar ierr = PetscObjectGrantAccess(snes);CHKERRQ(ierr); 794fe835674SShri Abhyankar SNESLogConvHistory(snes,fnorm,0); 795fe835674SShri Abhyankar SNESMonitor(snes,0,fnorm); 796d950fb63SShri Abhyankar 797d950fb63SShri Abhyankar /* set parameter for default relative tolerance convergence test */ 798fe835674SShri Abhyankar snes->ttol = fnorm*snes->rtol; 799d950fb63SShri Abhyankar /* test convergence */ 800fe835674SShri Abhyankar ierr = (*snes->ops->converged)(snes,0,0.0,0.0,fnorm,&snes->reason,snes->cnvP);CHKERRQ(ierr); 801d950fb63SShri Abhyankar if (snes->reason) PetscFunctionReturn(0); 802d950fb63SShri Abhyankar 803d950fb63SShri Abhyankar for (i=0; i<maxits; i++) { 804d950fb63SShri Abhyankar 805d950fb63SShri Abhyankar IS IS_act,IS_inact; /* _act -> active set _inact -> inactive set */ 806d950fb63SShri Abhyankar VecScatter scat_act,scat_inact; 807abcba341SShri Abhyankar PetscInt nis_act,nis_inact; 808fe835674SShri Abhyankar Vec Y_act,Y_inact,F_inact; 809d950fb63SShri Abhyankar Mat jac_inact_inact,prejac_inact_inact; 81062298a1eSBarry Smith IS keptrows; 811abcba341SShri Abhyankar PetscBool isequal; 812d950fb63SShri Abhyankar 813d950fb63SShri Abhyankar /* Call general purpose update function */ 814d950fb63SShri Abhyankar if (snes->ops->update) { 815d950fb63SShri Abhyankar ierr = (*snes->ops->update)(snes, snes->iter);CHKERRQ(ierr); 816d950fb63SShri Abhyankar } 817d950fb63SShri Abhyankar ierr = SNESComputeJacobian(snes,X,&snes->jacobian,&snes->jacobian_pre,&flg);CHKERRQ(ierr); 81862298a1eSBarry Smith 819d950fb63SShri Abhyankar /* Create active and inactive index sets */ 820693ddf92SShri Abhyankar ierr = SNESVICreateIndexSets_RS(snes,X,F,&IS_act,&IS_inact);CHKERRQ(ierr); 821d950fb63SShri Abhyankar 822abcba341SShri Abhyankar /* Create inactive set submatrix */ 82362298a1eSBarry Smith ierr = MatGetSubMatrix(snes->jacobian,IS_inact,IS_inact,MAT_INITIAL_MATRIX,&jac_inact_inact);CHKERRQ(ierr); 824b3a44c85SBarry Smith ierr = MatFindNonzeroRows(jac_inact_inact,&keptrows);CHKERRQ(ierr); 82562298a1eSBarry Smith if (keptrows) { 82662298a1eSBarry Smith PetscInt cnt,*nrows,k; 82762298a1eSBarry Smith const PetscInt *krows,*inact; 82827d4218bSShri Abhyankar PetscInt rstart=jac_inact_inact->rmap->rstart; 82962298a1eSBarry Smith 8306bf464f9SBarry Smith ierr = MatDestroy(&jac_inact_inact);CHKERRQ(ierr); 8316bf464f9SBarry Smith ierr = ISDestroy(&IS_act);CHKERRQ(ierr); 83262298a1eSBarry Smith 83362298a1eSBarry Smith ierr = ISGetLocalSize(keptrows,&cnt);CHKERRQ(ierr); 83462298a1eSBarry Smith ierr = ISGetIndices(keptrows,&krows);CHKERRQ(ierr); 83562298a1eSBarry Smith ierr = ISGetIndices(IS_inact,&inact);CHKERRQ(ierr); 83662298a1eSBarry Smith ierr = PetscMalloc(cnt*sizeof(PetscInt),&nrows);CHKERRQ(ierr); 83762298a1eSBarry Smith for (k=0; k<cnt; k++) { 83827d4218bSShri Abhyankar nrows[k] = inact[krows[k]-rstart]; 83962298a1eSBarry Smith } 84062298a1eSBarry Smith ierr = ISRestoreIndices(keptrows,&krows);CHKERRQ(ierr); 84162298a1eSBarry Smith ierr = ISRestoreIndices(IS_inact,&inact);CHKERRQ(ierr); 8426bf464f9SBarry Smith ierr = ISDestroy(&keptrows);CHKERRQ(ierr); 8436bf464f9SBarry Smith ierr = ISDestroy(&IS_inact);CHKERRQ(ierr); 84462298a1eSBarry Smith 84527d4218bSShri Abhyankar ierr = ISCreateGeneral(PETSC_COMM_WORLD,cnt,nrows,PETSC_OWN_POINTER,&IS_inact);CHKERRQ(ierr); 84627d4218bSShri Abhyankar ierr = ISComplement(IS_inact,F->map->rstart,F->map->rend,&IS_act);CHKERRQ(ierr); 84762298a1eSBarry Smith ierr = MatGetSubMatrix(snes->jacobian,IS_inact,IS_inact,MAT_INITIAL_MATRIX,&jac_inact_inact);CHKERRQ(ierr); 84862298a1eSBarry Smith } 84962298a1eSBarry Smith 850d950fb63SShri Abhyankar /* Get sizes of active and inactive sets */ 851d950fb63SShri Abhyankar ierr = ISGetLocalSize(IS_act,&nis_act);CHKERRQ(ierr); 852d950fb63SShri Abhyankar ierr = ISGetLocalSize(IS_inact,&nis_inact);CHKERRQ(ierr); 853d950fb63SShri Abhyankar 854d950fb63SShri Abhyankar /* Create active and inactive set vectors */ 855fe835674SShri Abhyankar ierr = SNESVICreateSubVectors(snes,nis_inact,&F_inact);CHKERRQ(ierr); 856fe835674SShri Abhyankar ierr = SNESVICreateSubVectors(snes,nis_act,&Y_act);CHKERRQ(ierr); 857fe835674SShri Abhyankar ierr = SNESVICreateSubVectors(snes,nis_inact,&Y_inact);CHKERRQ(ierr); 858d950fb63SShri Abhyankar 859d950fb63SShri Abhyankar /* Create scatter contexts */ 860d950fb63SShri Abhyankar ierr = VecScatterCreate(Y,IS_act,Y_act,PETSC_NULL,&scat_act);CHKERRQ(ierr); 861d950fb63SShri Abhyankar ierr = VecScatterCreate(Y,IS_inact,Y_inact,PETSC_NULL,&scat_inact);CHKERRQ(ierr); 862d950fb63SShri Abhyankar 863d950fb63SShri Abhyankar /* Do a vec scatter to active and inactive set vectors */ 864fe835674SShri Abhyankar ierr = VecScatterBegin(scat_inact,F,F_inact,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 865fe835674SShri Abhyankar ierr = VecScatterEnd(scat_inact,F,F_inact,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 866d950fb63SShri Abhyankar 867d950fb63SShri Abhyankar ierr = VecScatterBegin(scat_act,Y,Y_act,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 868d950fb63SShri Abhyankar ierr = VecScatterEnd(scat_act,Y,Y_act,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 869d950fb63SShri Abhyankar 870d950fb63SShri Abhyankar ierr = VecScatterBegin(scat_inact,Y,Y_inact,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 871d950fb63SShri Abhyankar ierr = VecScatterEnd(scat_inact,Y,Y_inact,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 872d950fb63SShri Abhyankar 873d950fb63SShri Abhyankar /* Active set direction = 0 */ 874d950fb63SShri Abhyankar ierr = VecSet(Y_act,0);CHKERRQ(ierr); 875d950fb63SShri Abhyankar if (snes->jacobian != snes->jacobian_pre) { 876d950fb63SShri Abhyankar ierr = MatGetSubMatrix(snes->jacobian_pre,IS_inact,IS_inact,MAT_INITIAL_MATRIX,&prejac_inact_inact);CHKERRQ(ierr); 877d950fb63SShri Abhyankar } else prejac_inact_inact = jac_inact_inact; 878d950fb63SShri Abhyankar 879abcba341SShri Abhyankar ierr = ISEqual(vi->IS_inact_prev,IS_inact,&isequal);CHKERRQ(ierr); 880abcba341SShri Abhyankar if (!isequal) { 881732bb160SShri Abhyankar ierr = SNESVIResetPCandKSP(snes,jac_inact_inact,prejac_inact_inact);CHKERRQ(ierr); 882d950fb63SShri Abhyankar } 883d950fb63SShri Abhyankar 88413e0d083SBarry Smith /* ierr = ISView(IS_inact,0);CHKERRQ(ierr); */ 88513e0d083SBarry Smith /* ierr = ISView(IS_act,0);CHKERRQ(ierr);*/ 88613e0d083SBarry Smith /* ierr = MatView(snes->jacobian_pre,0); */ 88713e0d083SBarry Smith 888d950fb63SShri Abhyankar ierr = KSPSetOperators(snes->ksp,jac_inact_inact,prejac_inact_inact,flg);CHKERRQ(ierr); 88913e0d083SBarry Smith ierr = KSPSetUp(snes->ksp);CHKERRQ(ierr); 89013e0d083SBarry Smith { 89113e0d083SBarry Smith PC pc; 89213e0d083SBarry Smith PetscBool flg; 89313e0d083SBarry Smith ierr = KSPGetPC(snes->ksp,&pc);CHKERRQ(ierr); 89413e0d083SBarry Smith ierr = PetscTypeCompare((PetscObject)pc,PCFIELDSPLIT,&flg);CHKERRQ(ierr); 89513e0d083SBarry Smith if (flg) { 89613e0d083SBarry Smith KSP *subksps; 89713e0d083SBarry Smith ierr = PCFieldSplitGetSubKSP(pc,PETSC_NULL,&subksps);CHKERRQ(ierr); 89813e0d083SBarry Smith ierr = KSPGetPC(subksps[0],&pc);CHKERRQ(ierr); 89913e0d083SBarry Smith ierr = PetscFree(subksps);CHKERRQ(ierr); 90013e0d083SBarry Smith ierr = PetscTypeCompare((PetscObject)pc,PCBJACOBI,&flg);CHKERRQ(ierr); 90113e0d083SBarry Smith if (flg) { 90213e0d083SBarry Smith PetscInt n,N = 101*101,j,cnts[3] = {0,0,0}; 90313e0d083SBarry Smith const PetscInt *ii; 90413e0d083SBarry Smith 90513e0d083SBarry Smith ierr = ISGetSize(IS_inact,&n);CHKERRQ(ierr); 90613e0d083SBarry Smith ierr = ISGetIndices(IS_inact,&ii);CHKERRQ(ierr); 90713e0d083SBarry Smith for (j=0; j<n; j++) { 90813e0d083SBarry Smith if (ii[j] < N) cnts[0]++; 90913e0d083SBarry Smith else if (ii[j] < 2*N) cnts[1]++; 91013e0d083SBarry Smith else if (ii[j] < 3*N) cnts[2]++; 91113e0d083SBarry Smith } 91213e0d083SBarry Smith ierr = ISRestoreIndices(IS_inact,&ii);CHKERRQ(ierr); 91313e0d083SBarry Smith 91413e0d083SBarry Smith ierr = PCBJacobiSetTotalBlocks(pc,3,cnts);CHKERRQ(ierr); 91513e0d083SBarry Smith } 91613e0d083SBarry Smith } 91713e0d083SBarry Smith } 91813e0d083SBarry Smith 919fe835674SShri Abhyankar ierr = SNES_KSPSolve(snes,snes->ksp,F_inact,Y_inact);CHKERRQ(ierr); 920d950fb63SShri Abhyankar ierr = KSPGetConvergedReason(snes->ksp,&kspreason);CHKERRQ(ierr); 921d950fb63SShri Abhyankar if (kspreason < 0) { 922d950fb63SShri Abhyankar if (++snes->numLinearSolveFailures >= snes->maxLinearSolveFailures) { 923d950fb63SShri Abhyankar ierr = PetscInfo2(snes,"iter=%D, number linear solve failures %D greater than current SNES allowed, stopping solve\n",snes->iter,snes->numLinearSolveFailures);CHKERRQ(ierr); 924d950fb63SShri Abhyankar snes->reason = SNES_DIVERGED_LINEAR_SOLVE; 925d950fb63SShri Abhyankar break; 926d950fb63SShri Abhyankar } 927d950fb63SShri Abhyankar } 928d950fb63SShri Abhyankar 929d950fb63SShri Abhyankar ierr = VecScatterBegin(scat_act,Y_act,Y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 930d950fb63SShri Abhyankar ierr = VecScatterEnd(scat_act,Y_act,Y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 931d950fb63SShri Abhyankar ierr = VecScatterBegin(scat_inact,Y_inact,Y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 932d950fb63SShri Abhyankar ierr = VecScatterEnd(scat_inact,Y_inact,Y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 933d950fb63SShri Abhyankar 9346bf464f9SBarry Smith ierr = VecDestroy(&F_inact);CHKERRQ(ierr); 9356bf464f9SBarry Smith ierr = VecDestroy(&Y_act);CHKERRQ(ierr); 9366bf464f9SBarry Smith ierr = VecDestroy(&Y_inact);CHKERRQ(ierr); 9376bf464f9SBarry Smith ierr = VecScatterDestroy(&scat_act);CHKERRQ(ierr); 9386bf464f9SBarry Smith ierr = VecScatterDestroy(&scat_inact);CHKERRQ(ierr); 9396bf464f9SBarry Smith ierr = ISDestroy(&IS_act);CHKERRQ(ierr); 940abcba341SShri Abhyankar if (!isequal) { 9416bf464f9SBarry Smith ierr = ISDestroy(&vi->IS_inact_prev);CHKERRQ(ierr); 942abcba341SShri Abhyankar ierr = ISDuplicate(IS_inact,&vi->IS_inact_prev);CHKERRQ(ierr); 943abcba341SShri Abhyankar } 9446bf464f9SBarry Smith ierr = ISDestroy(&IS_inact);CHKERRQ(ierr); 9456bf464f9SBarry Smith ierr = MatDestroy(&jac_inact_inact);CHKERRQ(ierr); 946d950fb63SShri Abhyankar if (snes->jacobian != snes->jacobian_pre) { 9476bf464f9SBarry Smith ierr = MatDestroy(&prejac_inact_inact);CHKERRQ(ierr); 948d950fb63SShri Abhyankar } 949d950fb63SShri Abhyankar ierr = KSPGetIterationNumber(snes->ksp,&lits);CHKERRQ(ierr); 950d950fb63SShri Abhyankar snes->linear_its += lits; 951d950fb63SShri Abhyankar ierr = PetscInfo2(snes,"iter=%D, linear solve iterations=%D\n",snes->iter,lits);CHKERRQ(ierr); 952d950fb63SShri Abhyankar /* 953d950fb63SShri Abhyankar if (vi->precheckstep) { 954d950fb63SShri Abhyankar PetscBool changed_y = PETSC_FALSE; 955d950fb63SShri Abhyankar ierr = (*vi->precheckstep)(snes,X,Y,vi->precheck,&changed_y);CHKERRQ(ierr); 956d950fb63SShri Abhyankar } 957d950fb63SShri Abhyankar 958d950fb63SShri Abhyankar if (PetscLogPrintInfo){ 959d950fb63SShri Abhyankar ierr = SNESVICheckResidual_Private(snes,snes->jacobian,F,Y,G,W);CHKERRQ(ierr); 960d950fb63SShri Abhyankar } 961d950fb63SShri Abhyankar */ 962d950fb63SShri Abhyankar /* Compute a (scaled) negative update in the line search routine: 963d950fb63SShri Abhyankar Y <- X - lambda*Y 964d950fb63SShri Abhyankar and evaluate G = function(Y) (depends on the line search). 965d950fb63SShri Abhyankar */ 966d950fb63SShri Abhyankar ierr = VecCopy(Y,snes->vec_sol_update);CHKERRQ(ierr); 967fe835674SShri Abhyankar ynorm = 1; gnorm = fnorm; 968fe835674SShri Abhyankar ierr = (*vi->LineSearch)(snes,vi->lsP,X,F,G,Y,W,fnorm,xnorm,&ynorm,&gnorm,&lssucceed);CHKERRQ(ierr); 969fe835674SShri Abhyankar ierr = PetscInfo4(snes,"fnorm=%18.16e, gnorm=%18.16e, ynorm=%18.16e, lssucceed=%d\n",fnorm,gnorm,ynorm,(int)lssucceed);CHKERRQ(ierr); 9702b4ed282SShri Abhyankar if (snes->reason == SNES_DIVERGED_FUNCTION_COUNT) break; 9712b4ed282SShri Abhyankar if (snes->domainerror) { 9722b4ed282SShri Abhyankar snes->reason = SNES_DIVERGED_FUNCTION_DOMAIN; 9732b4ed282SShri Abhyankar PetscFunctionReturn(0); 9742b4ed282SShri Abhyankar } 9752b4ed282SShri Abhyankar if (!lssucceed) { 9762b4ed282SShri Abhyankar if (++snes->numFailures >= snes->maxFailures) { 9772b4ed282SShri Abhyankar PetscBool ismin; 9782b4ed282SShri Abhyankar snes->reason = SNES_DIVERGED_LINE_SEARCH; 9792b4ed282SShri Abhyankar ierr = SNESVICheckLocalMin_Private(snes,snes->jacobian,G,W,gnorm,&ismin);CHKERRQ(ierr); 9802b4ed282SShri Abhyankar if (ismin) snes->reason = SNES_DIVERGED_LOCAL_MIN; 9812b4ed282SShri Abhyankar break; 9822b4ed282SShri Abhyankar } 9832b4ed282SShri Abhyankar } 9842b4ed282SShri Abhyankar /* Update function and solution vectors */ 985fe835674SShri Abhyankar fnorm = gnorm; 986fe835674SShri Abhyankar ierr = VecCopy(G,F);CHKERRQ(ierr); 9872b4ed282SShri Abhyankar ierr = VecCopy(W,X);CHKERRQ(ierr); 9882b4ed282SShri Abhyankar /* Monitor convergence */ 9892b4ed282SShri Abhyankar ierr = PetscObjectTakeAccess(snes);CHKERRQ(ierr); 9902b4ed282SShri Abhyankar snes->iter = i+1; 991fe835674SShri Abhyankar snes->norm = fnorm; 9922b4ed282SShri Abhyankar ierr = PetscObjectGrantAccess(snes);CHKERRQ(ierr); 9932b4ed282SShri Abhyankar SNESLogConvHistory(snes,snes->norm,lits); 9942b4ed282SShri Abhyankar SNESMonitor(snes,snes->iter,snes->norm); 9952b4ed282SShri Abhyankar /* Test for convergence, xnorm = || X || */ 9962b4ed282SShri Abhyankar if (snes->ops->converged != SNESSkipConverged) { ierr = VecNorm(X,NORM_2,&xnorm);CHKERRQ(ierr); } 997fe835674SShri Abhyankar ierr = (*snes->ops->converged)(snes,snes->iter,xnorm,ynorm,fnorm,&snes->reason,snes->cnvP);CHKERRQ(ierr); 9982b4ed282SShri Abhyankar if (snes->reason) break; 9992b4ed282SShri Abhyankar } 10002b4ed282SShri Abhyankar if (i == maxits) { 10012b4ed282SShri Abhyankar ierr = PetscInfo1(snes,"Maximum number of iterations has been reached: %D\n",maxits);CHKERRQ(ierr); 10022b4ed282SShri Abhyankar if(!snes->reason) snes->reason = SNES_DIVERGED_MAX_IT; 10032b4ed282SShri Abhyankar } 10042b4ed282SShri Abhyankar PetscFunctionReturn(0); 10052b4ed282SShri Abhyankar } 10062b4ed282SShri Abhyankar 10072f63a38cSShri Abhyankar #undef __FUNCT__ 1008720c9a41SShri Abhyankar #define __FUNCT__ "SNESVISetRedundancyCheck" 1009*cb5fe31bSShri Abhyankar PetscErrorCode SNESVISetRedundancyCheck(SNES snes,PetscErrorCode (*func)(SNES,IS,IS*,void*),void *ctx) 10102f63a38cSShri Abhyankar { 10112f63a38cSShri Abhyankar SNES_VI *vi = (SNES_VI*)snes->data; 10122f63a38cSShri Abhyankar 10132f63a38cSShri Abhyankar PetscFunctionBegin; 10142f63a38cSShri Abhyankar PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 10152f63a38cSShri Abhyankar vi->checkredundancy = func; 1016*cb5fe31bSShri Abhyankar vi->ctxP = ctx; 10172f63a38cSShri Abhyankar PetscFunctionReturn(0); 10182f63a38cSShri Abhyankar } 10192f63a38cSShri Abhyankar 1020ff596062SShri Abhyankar #if defined(PETSC_HAVE_MATLAB_ENGINE) 1021ff596062SShri Abhyankar #include <engine.h> 1022ff596062SShri Abhyankar #include <mex.h> 1023*cb5fe31bSShri Abhyankar typedef struct {char *funcname; mxArray *ctx;} SNESMatlabContext; 1024ff596062SShri Abhyankar 1025ff596062SShri Abhyankar #undef __FUNCT__ 1026ff596062SShri Abhyankar #define __FUNCT__ "SNESVIRedundancyCheck_Matlab" 1027ff596062SShri Abhyankar PetscErrorCode SNESVIRedundancyCheck_Matlab(SNES snes,IS is_act,IS* is_redact,void* ctx) 1028ff596062SShri Abhyankar { 1029ff596062SShri Abhyankar PetscErrorCode ierr; 1030*cb5fe31bSShri Abhyankar SNESMatlabContext *sctx = (SNESMatlabContext*)ctx; 1031*cb5fe31bSShri Abhyankar int nlhs = 1, nrhs = 5; 1032*cb5fe31bSShri Abhyankar mxArray *plhs[1], *prhs[5]; 1033*cb5fe31bSShri Abhyankar long long int l1 = 0, l2 = 0,ls = 0; 1034ff596062SShri Abhyankar 1035ff596062SShri Abhyankar PetscFunctionBegin; 1036ff596062SShri Abhyankar PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 1037ff596062SShri Abhyankar PetscValidHeaderSpecific(is_act,IS_CLASSID,2); 1038ff596062SShri Abhyankar PetscValidPointer(is_redact,3); 1039ff596062SShri Abhyankar PetscCheckSameComm(snes,1,is_act,2); 1040ff596062SShri Abhyankar 1041*cb5fe31bSShri Abhyankar /* Create IS for reduced active set, its size and indices will be set by the Matlab function */ 1042*cb5fe31bSShri Abhyankar ierr = ISCreate(((PetscObject)snes)->comm,is_redact);CHKERRQ(ierr); 1043*cb5fe31bSShri Abhyankar /* call Matlab function in ctx */ 1044ff596062SShri Abhyankar ierr = PetscMemcpy(&ls,&snes,sizeof(snes));CHKERRQ(ierr); 1045ff596062SShri Abhyankar ierr = PetscMemcpy(&l1,&is_act,sizeof(is_act));CHKERRQ(ierr); 1046*cb5fe31bSShri Abhyankar ierr = PetscMemcpy(&l2,is_redact,sizeof(is_act));CHKERRQ(ierr); 1047ff596062SShri Abhyankar prhs[0] = mxCreateDoubleScalar((double)ls); 1048ff596062SShri Abhyankar prhs[1] = mxCreateDoubleScalar((double)l1); 1049*cb5fe31bSShri Abhyankar prhs[2] = mxCreateDoubleScalar((double)l2); 1050*cb5fe31bSShri Abhyankar prhs[3] = mxCreateString(sctx->funcname); 1051*cb5fe31bSShri Abhyankar prhs[4] = sctx->ctx; 1052ff596062SShri Abhyankar ierr = mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscSNESVIRedundancyCheckInternal");CHKERRQ(ierr); 1053ff596062SShri Abhyankar ierr = mxGetScalar(plhs[0]);CHKERRQ(ierr); 1054*cb5fe31bSShri Abhyankar PetscInt n; 1055*cb5fe31bSShri Abhyankar ierr = ISGetSize(*is_redact,&n);CHKERRQ(ierr); 1056*cb5fe31bSShri Abhyankar PetscPrintf(PETSC_COMM_SELF,"IS_size = %d\n",n); 1057ff596062SShri Abhyankar mxDestroyArray(prhs[0]); 1058ff596062SShri Abhyankar mxDestroyArray(prhs[1]); 1059ff596062SShri Abhyankar mxDestroyArray(prhs[2]); 1060ff596062SShri Abhyankar mxDestroyArray(prhs[3]); 1061*cb5fe31bSShri Abhyankar mxDestroyArray(prhs[4]); 1062ff596062SShri Abhyankar mxDestroyArray(plhs[0]); 1063ff596062SShri Abhyankar PetscFunctionReturn(0); 1064ff596062SShri Abhyankar } 1065ff596062SShri Abhyankar 1066ff596062SShri Abhyankar #undef __FUNCT__ 1067ff596062SShri Abhyankar #define __FUNCT__ "SNESVISetRedundancyCheckMatlab" 1068ff596062SShri Abhyankar PetscErrorCode SNESVISetRedundancyCheckMatlab(SNES snes,const char* func,mxArray* ctx) 1069ff596062SShri Abhyankar { 1070ff596062SShri Abhyankar PetscErrorCode ierr; 1071*cb5fe31bSShri Abhyankar SNESMatlabContext *sctx; 1072ff596062SShri Abhyankar 1073ff596062SShri Abhyankar PetscFunctionBegin; 1074ff596062SShri Abhyankar /* currently sctx is memory bleed */ 1075*cb5fe31bSShri Abhyankar ierr = PetscMalloc(sizeof(SNESMatlabContext),&sctx);CHKERRQ(ierr); 1076ff596062SShri Abhyankar ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr); 1077ff596062SShri Abhyankar sctx->ctx = mxDuplicateArray(ctx); 1078*cb5fe31bSShri Abhyankar ierr = SNESVISetRedundancyCheck(snes,SNESVIRedundancyCheck_Matlab,sctx);CHKERRQ(ierr); 1079ff596062SShri Abhyankar PetscFunctionReturn(0); 1080ff596062SShri Abhyankar } 1081ff596062SShri Abhyankar 1082ff596062SShri Abhyankar #endif 1083ff596062SShri Abhyankar 1084ff596062SShri Abhyankar 10852f63a38cSShri Abhyankar /* Variational Inequality solver using augmented space method. It does the opposite of the 10862f63a38cSShri Abhyankar reduced space method i.e. it identifies the active set variables and instead of discarding 1087720c9a41SShri Abhyankar them it augments the original system by introducing additional equality 108856a221efSShri Abhyankar constraint equations for active set variables. The user can optionally provide an IS for 108956a221efSShri Abhyankar a subset of 'redundant' active set variables which will treated as free variables. 10902f63a38cSShri Abhyankar Specific implementation for Allen-Cahn problem 10912f63a38cSShri Abhyankar */ 10922f63a38cSShri Abhyankar #undef __FUNCT__ 10932f63a38cSShri Abhyankar #define __FUNCT__ "SNESSolveVI_RS2" 10942f63a38cSShri Abhyankar PetscErrorCode SNESSolveVI_RS2(SNES snes) 10952f63a38cSShri Abhyankar { 10962f63a38cSShri Abhyankar SNES_VI *vi = (SNES_VI*)snes->data; 10972f63a38cSShri Abhyankar PetscErrorCode ierr; 10982f63a38cSShri Abhyankar PetscInt maxits,i,lits; 10992f63a38cSShri Abhyankar PetscBool lssucceed; 11002f63a38cSShri Abhyankar MatStructure flg = DIFFERENT_NONZERO_PATTERN; 11012f63a38cSShri Abhyankar PetscReal fnorm,gnorm,xnorm=0,ynorm; 11022f63a38cSShri Abhyankar Vec Y,X,F,G,W; 11032f63a38cSShri Abhyankar KSPConvergedReason kspreason; 11042f63a38cSShri Abhyankar 11052f63a38cSShri Abhyankar PetscFunctionBegin; 11062f63a38cSShri Abhyankar snes->numFailures = 0; 11072f63a38cSShri Abhyankar snes->numLinearSolveFailures = 0; 11082f63a38cSShri Abhyankar snes->reason = SNES_CONVERGED_ITERATING; 11092f63a38cSShri Abhyankar 11102f63a38cSShri Abhyankar maxits = snes->max_its; /* maximum number of iterations */ 11112f63a38cSShri Abhyankar X = snes->vec_sol; /* solution vector */ 11122f63a38cSShri Abhyankar F = snes->vec_func; /* residual vector */ 11132f63a38cSShri Abhyankar Y = snes->work[0]; /* work vectors */ 11142f63a38cSShri Abhyankar G = snes->work[1]; 11152f63a38cSShri Abhyankar W = snes->work[2]; 11162f63a38cSShri Abhyankar 11172f63a38cSShri Abhyankar ierr = PetscObjectTakeAccess(snes);CHKERRQ(ierr); 11182f63a38cSShri Abhyankar snes->iter = 0; 11192f63a38cSShri Abhyankar snes->norm = 0.0; 11202f63a38cSShri Abhyankar ierr = PetscObjectGrantAccess(snes);CHKERRQ(ierr); 11212f63a38cSShri Abhyankar 11222f63a38cSShri Abhyankar ierr = SNESVIProjectOntoBounds(snes,X);CHKERRQ(ierr); 11232f63a38cSShri Abhyankar ierr = SNESComputeFunction(snes,X,F);CHKERRQ(ierr); 11242f63a38cSShri Abhyankar if (snes->domainerror) { 11252f63a38cSShri Abhyankar snes->reason = SNES_DIVERGED_FUNCTION_DOMAIN; 11262f63a38cSShri Abhyankar PetscFunctionReturn(0); 11272f63a38cSShri Abhyankar } 11282f63a38cSShri Abhyankar ierr = SNESVIComputeInactiveSetFnorm(snes,F,X,&fnorm);CHKERRQ(ierr); 11292f63a38cSShri Abhyankar ierr = VecNormBegin(X,NORM_2,&xnorm);CHKERRQ(ierr); /* xnorm <- ||x|| */ 11302f63a38cSShri Abhyankar ierr = VecNormEnd(X,NORM_2,&xnorm);CHKERRQ(ierr); 113162cbcd01SMatthew G Knepley if (PetscIsInfOrNanReal(fnorm)) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FP,"User provided compute function generated a Not-a-Number"); 11322f63a38cSShri Abhyankar 11332f63a38cSShri Abhyankar ierr = PetscObjectTakeAccess(snes);CHKERRQ(ierr); 11342f63a38cSShri Abhyankar snes->norm = fnorm; 11352f63a38cSShri Abhyankar ierr = PetscObjectGrantAccess(snes);CHKERRQ(ierr); 11362f63a38cSShri Abhyankar SNESLogConvHistory(snes,fnorm,0); 11372f63a38cSShri Abhyankar SNESMonitor(snes,0,fnorm); 11382f63a38cSShri Abhyankar 11392f63a38cSShri Abhyankar /* set parameter for default relative tolerance convergence test */ 11402f63a38cSShri Abhyankar snes->ttol = fnorm*snes->rtol; 11412f63a38cSShri Abhyankar /* test convergence */ 11422f63a38cSShri Abhyankar ierr = (*snes->ops->converged)(snes,0,0.0,0.0,fnorm,&snes->reason,snes->cnvP);CHKERRQ(ierr); 11432f63a38cSShri Abhyankar if (snes->reason) PetscFunctionReturn(0); 11442f63a38cSShri Abhyankar 11452f63a38cSShri Abhyankar for (i=0; i<maxits; i++) { 11462f63a38cSShri Abhyankar IS IS_act,IS_inact; /* _act -> active set _inact -> inactive set */ 1147*cb5fe31bSShri Abhyankar IS IS_redact; /* redundant active set */ 114856a221efSShri Abhyankar Mat J_aug,Jpre_aug; 114956a221efSShri Abhyankar Vec F_aug,Y_aug; 115056a221efSShri Abhyankar PetscInt nis_redact,nis_act; 115156a221efSShri Abhyankar const PetscInt *idx_redact,*idx_act; 115256a221efSShri Abhyankar PetscInt k; 1153*cb5fe31bSShri Abhyankar PetscInt *idx_actkept=PETSC_NULL,nkept; /* list of kept active set */ 115456a221efSShri Abhyankar PetscScalar *f,*f2; 11552f63a38cSShri Abhyankar PetscBool isequal; 115656a221efSShri Abhyankar PetscInt i1=0,j1=0; 11572f63a38cSShri Abhyankar 11582f63a38cSShri Abhyankar /* Call general purpose update function */ 11592f63a38cSShri Abhyankar if (snes->ops->update) { 11602f63a38cSShri Abhyankar ierr = (*snes->ops->update)(snes, snes->iter);CHKERRQ(ierr); 11612f63a38cSShri Abhyankar } 11622f63a38cSShri Abhyankar ierr = SNESComputeJacobian(snes,X,&snes->jacobian,&snes->jacobian_pre,&flg);CHKERRQ(ierr); 11632f63a38cSShri Abhyankar 11642f63a38cSShri Abhyankar /* Create active and inactive index sets */ 11652f63a38cSShri Abhyankar ierr = SNESVICreateIndexSets_RS(snes,X,F,&IS_act,&IS_inact);CHKERRQ(ierr); 11662f63a38cSShri Abhyankar 116756a221efSShri Abhyankar /* Get local active set size */ 11682f63a38cSShri Abhyankar ierr = ISGetLocalSize(IS_act,&nis_act);CHKERRQ(ierr); 116956a221efSShri Abhyankar ierr = ISGetIndices(IS_act,&idx_act);CHKERRQ(ierr); 117056a221efSShri Abhyankar if(nis_act) { 117156a221efSShri Abhyankar if(vi->checkredundancy) { 1172*cb5fe31bSShri Abhyankar (*vi->checkredundancy)(snes,IS_act,&IS_redact,vi->ctxP); 117356a221efSShri Abhyankar } 11742f63a38cSShri Abhyankar 117556a221efSShri Abhyankar if(!IS_redact) { 117656a221efSShri Abhyankar /* User called checkredundancy function but didn't create IS_redact because 117756a221efSShri Abhyankar there were no redundant active set variables */ 117856a221efSShri Abhyankar /* Copy over all active set indices to the list */ 1179*cb5fe31bSShri Abhyankar PetscPrintf(PETSC_COMM_SELF,"Came here 1\n"); 118056a221efSShri Abhyankar ierr = PetscMalloc(nis_act*sizeof(PetscInt),&idx_actkept);CHKERRQ(ierr); 118156a221efSShri Abhyankar for(k=0;k < nis_act;k++) idx_actkept[k] = idx_act[k]; 118256a221efSShri Abhyankar nkept = nis_act; 118356a221efSShri Abhyankar } else { 1184*cb5fe31bSShri Abhyankar PetscPrintf(PETSC_COMM_SELF,"Came here 2\n"); 118556a221efSShri Abhyankar ierr = ISGetLocalSize(IS_redact,&nis_redact);CHKERRQ(ierr); 118656a221efSShri Abhyankar ierr = PetscMalloc((nis_act-nis_redact)*sizeof(PetscInt),&idx_actkept);CHKERRQ(ierr); 11872f63a38cSShri Abhyankar 118856a221efSShri Abhyankar /* Create reduced active set list */ 118956a221efSShri Abhyankar ierr = ISGetIndices(IS_act,&idx_act);CHKERRQ(ierr); 119056a221efSShri Abhyankar ierr = ISGetIndices(IS_redact,&idx_redact);CHKERRQ(ierr); 1191*cb5fe31bSShri Abhyankar j1 = 0;nkept = 0; 119256a221efSShri Abhyankar for(k=0;k<nis_act;k++) { 119356a221efSShri Abhyankar if(j1 < nis_redact && idx_act[k] == idx_redact[j1]) j1++; 119456a221efSShri Abhyankar else idx_actkept[nkept++] = idx_act[k]; 119556a221efSShri Abhyankar } 119656a221efSShri Abhyankar ierr = ISRestoreIndices(IS_act,&idx_act);CHKERRQ(ierr); 119756a221efSShri Abhyankar ierr = ISRestoreIndices(IS_redact,&idx_redact);CHKERRQ(ierr); 1198*cb5fe31bSShri Abhyankar 1199*cb5fe31bSShri Abhyankar ierr = ISDestroy(&IS_redact);CHKERRQ(ierr); 120056a221efSShri Abhyankar } 12012f63a38cSShri Abhyankar 120256a221efSShri Abhyankar /* Create augmented F and Y */ 120356a221efSShri Abhyankar ierr = VecCreate(((PetscObject)snes)->comm,&F_aug);CHKERRQ(ierr); 120456a221efSShri Abhyankar ierr = VecSetSizes(F_aug,F->map->n+nkept,PETSC_DECIDE);CHKERRQ(ierr); 120556a221efSShri Abhyankar ierr = VecSetFromOptions(F_aug);CHKERRQ(ierr); 120656a221efSShri Abhyankar ierr = VecDuplicate(F_aug,&Y_aug);CHKERRQ(ierr); 12072f63a38cSShri Abhyankar 120856a221efSShri Abhyankar /* Copy over F to F_aug in the first n locations */ 120956a221efSShri Abhyankar ierr = VecGetArray(F,&f);CHKERRQ(ierr); 121056a221efSShri Abhyankar ierr = VecGetArray(F_aug,&f2);CHKERRQ(ierr); 121156a221efSShri Abhyankar ierr = PetscMemcpy(f2,f,F->map->n*sizeof(PetscScalar));CHKERRQ(ierr); 121256a221efSShri Abhyankar ierr = VecRestoreArray(F,&f);CHKERRQ(ierr); 121356a221efSShri Abhyankar ierr = VecRestoreArray(F_aug,&f2);CHKERRQ(ierr); 12142f63a38cSShri Abhyankar 121556a221efSShri Abhyankar /* Create the augmented jacobian matrix */ 121656a221efSShri Abhyankar ierr = MatCreate(((PetscObject)snes)->comm,&J_aug);CHKERRQ(ierr); 121756a221efSShri Abhyankar ierr = MatSetSizes(J_aug,X->map->n+nkept,X->map->n+nkept,PETSC_DECIDE,PETSC_DECIDE);CHKERRQ(ierr); 121856a221efSShri Abhyankar ierr = MatSetFromOptions(J_aug);CHKERRQ(ierr); 12192f63a38cSShri Abhyankar 122056a221efSShri Abhyankar 12219521db3cSSatish Balay { /* local vars */ 1222493a4f3dSShri Abhyankar /* Preallocate augmented matrix and set values in it...Doing only sequential case first*/ 122356a221efSShri Abhyankar PetscInt ncols; 122456a221efSShri Abhyankar const PetscInt *cols; 122556a221efSShri Abhyankar const PetscScalar *vals; 122656a221efSShri Abhyankar PetscScalar value=1.0; 122756a221efSShri Abhyankar PetscInt row,col; 1228493a4f3dSShri Abhyankar PetscInt *d_nnz; 1229493a4f3dSShri Abhyankar 1230493a4f3dSShri Abhyankar ierr = PetscMalloc((X->map->n+nkept)*sizeof(PetscInt),&d_nnz);CHKERRQ(ierr); 1231493a4f3dSShri Abhyankar ierr = PetscMemzero(d_nnz,(X->map->n+nkept)*sizeof(PetscInt));CHKERRQ(ierr); 1232493a4f3dSShri Abhyankar for(row=0;row<snes->jacobian->rmap->n;row++) { 1233493a4f3dSShri Abhyankar ierr = MatGetRow(snes->jacobian,row,&ncols,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr); 1234493a4f3dSShri Abhyankar d_nnz[row] += ncols; 1235493a4f3dSShri Abhyankar ierr = MatRestoreRow(snes->jacobian,row,&ncols,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr); 1236493a4f3dSShri Abhyankar } 1237493a4f3dSShri Abhyankar 1238493a4f3dSShri Abhyankar for(k=0;k<nkept;k++) { 1239493a4f3dSShri Abhyankar d_nnz[idx_actkept[k]] += 1; 1240493a4f3dSShri Abhyankar d_nnz[snes->jacobian->rmap->n+k] += 1; 1241493a4f3dSShri Abhyankar } 1242493a4f3dSShri Abhyankar ierr = MatSeqAIJSetPreallocation(J_aug,PETSC_NULL,d_nnz);CHKERRQ(ierr); 1243493a4f3dSShri Abhyankar 1244493a4f3dSShri Abhyankar ierr = PetscFree(d_nnz);CHKERRQ(ierr); 124556a221efSShri Abhyankar 124656a221efSShri Abhyankar /* Set the original jacobian matrix in J_aug */ 124756a221efSShri Abhyankar for(row=0;row<snes->jacobian->rmap->n;row++) { 124856a221efSShri Abhyankar ierr = MatGetRow(snes->jacobian,row,&ncols,&cols,&vals);CHKERRQ(ierr); 124956a221efSShri Abhyankar ierr = MatSetValues(J_aug,1,&row,ncols,cols,vals,INSERT_VALUES);CHKERRQ(ierr); 125056a221efSShri Abhyankar ierr = MatRestoreRow(snes->jacobian,row,&ncols,&cols,&vals);CHKERRQ(ierr); 125156a221efSShri Abhyankar } 125256a221efSShri Abhyankar /* Add the augmented part */ 125356a221efSShri Abhyankar for(k=0;k<nkept;k++) { 125456a221efSShri Abhyankar row = idx_actkept[k]; 125556a221efSShri Abhyankar col = snes->jacobian->rmap->n+k; 125656a221efSShri Abhyankar ierr = MatSetValues(J_aug,1,&row,1,&col,&value,INSERT_VALUES);CHKERRQ(ierr); 125756a221efSShri Abhyankar ierr = MatSetValues(J_aug,1,&col,1,&row,&value,INSERT_VALUES);CHKERRQ(ierr); 125856a221efSShri Abhyankar } 125956a221efSShri Abhyankar ierr = MatAssemblyBegin(J_aug,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 126056a221efSShri Abhyankar ierr = MatAssemblyEnd(J_aug,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 126156a221efSShri Abhyankar /* Only considering prejac = jac for now */ 126256a221efSShri Abhyankar Jpre_aug = J_aug; 12639521db3cSSatish Balay } /* local vars*/ 126456a221efSShri Abhyankar } else { 126556a221efSShri Abhyankar F_aug = F; J_aug = snes->jacobian; Y_aug = Y; Jpre_aug = snes->jacobian_pre; 126656a221efSShri Abhyankar } 12672f63a38cSShri Abhyankar 12682f63a38cSShri Abhyankar ierr = ISEqual(vi->IS_inact_prev,IS_inact,&isequal);CHKERRQ(ierr); 12692f63a38cSShri Abhyankar if (!isequal) { 127056a221efSShri Abhyankar ierr = SNESVIResetPCandKSP(snes,J_aug,Jpre_aug);CHKERRQ(ierr); 12712f63a38cSShri Abhyankar } 127256a221efSShri Abhyankar ierr = KSPSetOperators(snes->ksp,J_aug,Jpre_aug,flg);CHKERRQ(ierr); 12732f63a38cSShri Abhyankar ierr = KSPSetUp(snes->ksp);CHKERRQ(ierr); 127456a221efSShri Abhyankar /* { 12752f63a38cSShri Abhyankar PC pc; 12762f63a38cSShri Abhyankar PetscBool flg; 12772f63a38cSShri Abhyankar ierr = KSPGetPC(snes->ksp,&pc);CHKERRQ(ierr); 12782f63a38cSShri Abhyankar ierr = PetscTypeCompare((PetscObject)pc,PCFIELDSPLIT,&flg);CHKERRQ(ierr); 12792f63a38cSShri Abhyankar if (flg) { 12802f63a38cSShri Abhyankar KSP *subksps; 12812f63a38cSShri Abhyankar ierr = PCFieldSplitGetSubKSP(pc,PETSC_NULL,&subksps);CHKERRQ(ierr); 12822f63a38cSShri Abhyankar ierr = KSPGetPC(subksps[0],&pc);CHKERRQ(ierr); 12832f63a38cSShri Abhyankar ierr = PetscFree(subksps);CHKERRQ(ierr); 12842f63a38cSShri Abhyankar ierr = PetscTypeCompare((PetscObject)pc,PCBJACOBI,&flg);CHKERRQ(ierr); 12852f63a38cSShri Abhyankar if (flg) { 12862f63a38cSShri Abhyankar PetscInt n,N = 101*101,j,cnts[3] = {0,0,0}; 12872f63a38cSShri Abhyankar const PetscInt *ii; 12882f63a38cSShri Abhyankar 12892f63a38cSShri Abhyankar ierr = ISGetSize(IS_inact,&n);CHKERRQ(ierr); 12902f63a38cSShri Abhyankar ierr = ISGetIndices(IS_inact,&ii);CHKERRQ(ierr); 12912f63a38cSShri Abhyankar for (j=0; j<n; j++) { 12922f63a38cSShri Abhyankar if (ii[j] < N) cnts[0]++; 12932f63a38cSShri Abhyankar else if (ii[j] < 2*N) cnts[1]++; 12942f63a38cSShri Abhyankar else if (ii[j] < 3*N) cnts[2]++; 12952f63a38cSShri Abhyankar } 12962f63a38cSShri Abhyankar ierr = ISRestoreIndices(IS_inact,&ii);CHKERRQ(ierr); 12972f63a38cSShri Abhyankar 12982f63a38cSShri Abhyankar ierr = PCBJacobiSetTotalBlocks(pc,3,cnts);CHKERRQ(ierr); 12992f63a38cSShri Abhyankar } 13002f63a38cSShri Abhyankar } 13012f63a38cSShri Abhyankar } 130256a221efSShri Abhyankar */ 130356a221efSShri Abhyankar ierr = SNES_KSPSolve(snes,snes->ksp,F_aug,Y_aug);CHKERRQ(ierr); 13042f63a38cSShri Abhyankar ierr = KSPGetConvergedReason(snes->ksp,&kspreason);CHKERRQ(ierr); 13052f63a38cSShri Abhyankar if (kspreason < 0) { 13062f63a38cSShri Abhyankar if (++snes->numLinearSolveFailures >= snes->maxLinearSolveFailures) { 13072f63a38cSShri Abhyankar ierr = PetscInfo2(snes,"iter=%D, number linear solve failures %D greater than current SNES allowed, stopping solve\n",snes->iter,snes->numLinearSolveFailures);CHKERRQ(ierr); 13082f63a38cSShri Abhyankar snes->reason = SNES_DIVERGED_LINEAR_SOLVE; 13092f63a38cSShri Abhyankar break; 13102f63a38cSShri Abhyankar } 13112f63a38cSShri Abhyankar } 13122f63a38cSShri Abhyankar 131356a221efSShri Abhyankar if(nis_act) { 131456a221efSShri Abhyankar PetscScalar *y1,*y2; 131556a221efSShri Abhyankar ierr = VecGetArray(Y,&y1);CHKERRQ(ierr); 131656a221efSShri Abhyankar ierr = VecGetArray(Y_aug,&y2);CHKERRQ(ierr); 131756a221efSShri Abhyankar /* Copy over inactive Y_aug to Y */ 131856a221efSShri Abhyankar j1 = 0; 131956a221efSShri Abhyankar for(i1=Y->map->rstart;i1 < Y->map->rend;i1++) { 132056a221efSShri Abhyankar if(j1 < nkept && idx_actkept[j1] == i1) j1++; 132156a221efSShri Abhyankar else y1[i1-Y->map->rstart] = y2[i1-Y->map->rstart]; 132256a221efSShri Abhyankar } 132356a221efSShri Abhyankar ierr = VecRestoreArray(Y,&y1);CHKERRQ(ierr); 132456a221efSShri Abhyankar ierr = VecRestoreArray(Y_aug,&y2);CHKERRQ(ierr); 13252f63a38cSShri Abhyankar 13266bf464f9SBarry Smith ierr = VecDestroy(&F_aug);CHKERRQ(ierr); 13276bf464f9SBarry Smith ierr = VecDestroy(&Y_aug);CHKERRQ(ierr); 13286bf464f9SBarry Smith ierr = MatDestroy(&J_aug);CHKERRQ(ierr); 132956a221efSShri Abhyankar ierr = PetscFree(idx_actkept);CHKERRQ(ierr); 133056a221efSShri Abhyankar } 133156a221efSShri Abhyankar 13322f63a38cSShri Abhyankar if (!isequal) { 13336bf464f9SBarry Smith ierr = ISDestroy(&vi->IS_inact_prev);CHKERRQ(ierr); 13342f63a38cSShri Abhyankar ierr = ISDuplicate(IS_inact,&vi->IS_inact_prev);CHKERRQ(ierr); 13352f63a38cSShri Abhyankar } 13366bf464f9SBarry Smith ierr = ISDestroy(&IS_inact);CHKERRQ(ierr); 133756a221efSShri Abhyankar 13382f63a38cSShri Abhyankar ierr = KSPGetIterationNumber(snes->ksp,&lits);CHKERRQ(ierr); 13392f63a38cSShri Abhyankar snes->linear_its += lits; 13402f63a38cSShri Abhyankar ierr = PetscInfo2(snes,"iter=%D, linear solve iterations=%D\n",snes->iter,lits);CHKERRQ(ierr); 13412f63a38cSShri Abhyankar /* 13422f63a38cSShri Abhyankar if (vi->precheckstep) { 13432f63a38cSShri Abhyankar PetscBool changed_y = PETSC_FALSE; 13442f63a38cSShri Abhyankar ierr = (*vi->precheckstep)(snes,X,Y,vi->precheck,&changed_y);CHKERRQ(ierr); 13452f63a38cSShri Abhyankar } 13462f63a38cSShri Abhyankar 13472f63a38cSShri Abhyankar if (PetscLogPrintInfo){ 13482f63a38cSShri Abhyankar ierr = SNESVICheckResidual_Private(snes,snes->jacobian,F,Y,G,W);CHKERRQ(ierr); 13492f63a38cSShri Abhyankar } 13502f63a38cSShri Abhyankar */ 13512f63a38cSShri Abhyankar /* Compute a (scaled) negative update in the line search routine: 13522f63a38cSShri Abhyankar Y <- X - lambda*Y 13532f63a38cSShri Abhyankar and evaluate G = function(Y) (depends on the line search). 13542f63a38cSShri Abhyankar */ 13552f63a38cSShri Abhyankar ierr = VecCopy(Y,snes->vec_sol_update);CHKERRQ(ierr); 13562f63a38cSShri Abhyankar ynorm = 1; gnorm = fnorm; 13572f63a38cSShri Abhyankar ierr = (*vi->LineSearch)(snes,vi->lsP,X,F,G,Y,W,fnorm,xnorm,&ynorm,&gnorm,&lssucceed);CHKERRQ(ierr); 13582f63a38cSShri Abhyankar ierr = PetscInfo4(snes,"fnorm=%18.16e, gnorm=%18.16e, ynorm=%18.16e, lssucceed=%d\n",fnorm,gnorm,ynorm,(int)lssucceed);CHKERRQ(ierr); 13592f63a38cSShri Abhyankar if (snes->reason == SNES_DIVERGED_FUNCTION_COUNT) break; 13602f63a38cSShri Abhyankar if (snes->domainerror) { 13612f63a38cSShri Abhyankar snes->reason = SNES_DIVERGED_FUNCTION_DOMAIN; 13622f63a38cSShri Abhyankar PetscFunctionReturn(0); 13632f63a38cSShri Abhyankar } 13642f63a38cSShri Abhyankar if (!lssucceed) { 13652f63a38cSShri Abhyankar if (++snes->numFailures >= snes->maxFailures) { 13662f63a38cSShri Abhyankar PetscBool ismin; 13672f63a38cSShri Abhyankar snes->reason = SNES_DIVERGED_LINE_SEARCH; 13682f63a38cSShri Abhyankar ierr = SNESVICheckLocalMin_Private(snes,snes->jacobian,G,W,gnorm,&ismin);CHKERRQ(ierr); 13692f63a38cSShri Abhyankar if (ismin) snes->reason = SNES_DIVERGED_LOCAL_MIN; 13702f63a38cSShri Abhyankar break; 13712f63a38cSShri Abhyankar } 13722f63a38cSShri Abhyankar } 13732f63a38cSShri Abhyankar /* Update function and solution vectors */ 13742f63a38cSShri Abhyankar fnorm = gnorm; 13752f63a38cSShri Abhyankar ierr = VecCopy(G,F);CHKERRQ(ierr); 13762f63a38cSShri Abhyankar ierr = VecCopy(W,X);CHKERRQ(ierr); 13772f63a38cSShri Abhyankar /* Monitor convergence */ 13782f63a38cSShri Abhyankar ierr = PetscObjectTakeAccess(snes);CHKERRQ(ierr); 13792f63a38cSShri Abhyankar snes->iter = i+1; 13802f63a38cSShri Abhyankar snes->norm = fnorm; 13812f63a38cSShri Abhyankar ierr = PetscObjectGrantAccess(snes);CHKERRQ(ierr); 13822f63a38cSShri Abhyankar SNESLogConvHistory(snes,snes->norm,lits); 13832f63a38cSShri Abhyankar SNESMonitor(snes,snes->iter,snes->norm); 13842f63a38cSShri Abhyankar /* Test for convergence, xnorm = || X || */ 13852f63a38cSShri Abhyankar if (snes->ops->converged != SNESSkipConverged) { ierr = VecNorm(X,NORM_2,&xnorm);CHKERRQ(ierr); } 13862f63a38cSShri Abhyankar ierr = (*snes->ops->converged)(snes,snes->iter,xnorm,ynorm,fnorm,&snes->reason,snes->cnvP);CHKERRQ(ierr); 13872f63a38cSShri Abhyankar if (snes->reason) break; 13882f63a38cSShri Abhyankar } 13892f63a38cSShri Abhyankar if (i == maxits) { 13902f63a38cSShri Abhyankar ierr = PetscInfo1(snes,"Maximum number of iterations has been reached: %D\n",maxits);CHKERRQ(ierr); 13912f63a38cSShri Abhyankar if(!snes->reason) snes->reason = SNES_DIVERGED_MAX_IT; 13922f63a38cSShri Abhyankar } 13932f63a38cSShri Abhyankar PetscFunctionReturn(0); 13942f63a38cSShri Abhyankar } 13952f63a38cSShri Abhyankar 13962b4ed282SShri Abhyankar /* -------------------------------------------------------------------------- */ 13972b4ed282SShri Abhyankar /* 13982b4ed282SShri Abhyankar SNESSetUp_VI - Sets up the internal data structures for the later use 13992b4ed282SShri Abhyankar of the SNESVI nonlinear solver. 14002b4ed282SShri Abhyankar 14012b4ed282SShri Abhyankar Input Parameter: 14022b4ed282SShri Abhyankar . snes - the SNES context 14032b4ed282SShri Abhyankar . x - the solution vector 14042b4ed282SShri Abhyankar 14052b4ed282SShri Abhyankar Application Interface Routine: SNESSetUp() 14062b4ed282SShri Abhyankar 14072b4ed282SShri Abhyankar Notes: 14082b4ed282SShri Abhyankar For basic use of the SNES solvers, the user need not explicitly call 14092b4ed282SShri Abhyankar SNESSetUp(), since these actions will automatically occur during 14102b4ed282SShri Abhyankar the call to SNESSolve(). 14112b4ed282SShri Abhyankar */ 14122b4ed282SShri Abhyankar #undef __FUNCT__ 14132b4ed282SShri Abhyankar #define __FUNCT__ "SNESSetUp_VI" 14142b4ed282SShri Abhyankar PetscErrorCode SNESSetUp_VI(SNES snes) 14152b4ed282SShri Abhyankar { 14162b4ed282SShri Abhyankar PetscErrorCode ierr; 14172b4ed282SShri Abhyankar SNES_VI *vi = (SNES_VI*) snes->data; 14182b4ed282SShri Abhyankar PetscInt i_start[3],i_end[3]; 14192b4ed282SShri Abhyankar 14202b4ed282SShri Abhyankar PetscFunctionBegin; 142158c9b817SLisandro Dalcin 142258c9b817SLisandro Dalcin ierr = SNESDefaultGetWork(snes,3);CHKERRQ(ierr); 14232b4ed282SShri Abhyankar 14242b4ed282SShri Abhyankar /* If the lower and upper bound on variables are not set, set it to 14252b4ed282SShri Abhyankar -Inf and Inf */ 14262b4ed282SShri Abhyankar if (!vi->xl && !vi->xu) { 14272b4ed282SShri Abhyankar vi->usersetxbounds = PETSC_FALSE; 14282b4ed282SShri Abhyankar ierr = VecDuplicate(snes->vec_sol, &vi->xl); CHKERRQ(ierr); 14292b4ed282SShri Abhyankar ierr = VecSet(vi->xl,PETSC_VI_NINF);CHKERRQ(ierr); 14302b4ed282SShri Abhyankar ierr = VecDuplicate(snes->vec_sol, &vi->xu); CHKERRQ(ierr); 14312b4ed282SShri Abhyankar ierr = VecSet(vi->xu,PETSC_VI_INF);CHKERRQ(ierr); 14322b4ed282SShri Abhyankar } else { 14332b4ed282SShri Abhyankar /* Check if lower bound, upper bound and solution vector distribution across the processors is identical */ 14342b4ed282SShri Abhyankar ierr = VecGetOwnershipRange(snes->vec_sol,i_start,i_end);CHKERRQ(ierr); 14352b4ed282SShri Abhyankar ierr = VecGetOwnershipRange(vi->xl,i_start+1,i_end+1);CHKERRQ(ierr); 14362b4ed282SShri Abhyankar ierr = VecGetOwnershipRange(vi->xu,i_start+2,i_end+2);CHKERRQ(ierr); 14372b4ed282SShri Abhyankar if ((i_start[0] != i_start[1]) || (i_start[0] != i_start[2]) || (i_end[0] != i_end[1]) || (i_end[0] != i_end[2])) 14382b4ed282SShri Abhyankar SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_SIZ,"Distribution of lower bound, upper bound and the solution vector should be identical across all the processors."); 14392b4ed282SShri Abhyankar } 14402f63a38cSShri Abhyankar if (snes->ops->solve != SNESSolveVI_SS) { 1441abcba341SShri Abhyankar /* Set up previous active index set for the first snes solve 1442abcba341SShri Abhyankar vi->IS_inact_prev = 0,1,2,....N */ 1443abcba341SShri Abhyankar PetscInt *indices; 1444abcba341SShri Abhyankar PetscInt i,n,rstart,rend; 1445abcba341SShri Abhyankar 1446abcba341SShri Abhyankar ierr = VecGetOwnershipRange(snes->vec_sol,&rstart,&rend);CHKERRQ(ierr); 1447abcba341SShri Abhyankar ierr = VecGetLocalSize(snes->vec_sol,&n);CHKERRQ(ierr); 1448abcba341SShri Abhyankar ierr = PetscMalloc(n*sizeof(PetscInt),&indices);CHKERRQ(ierr); 1449abcba341SShri Abhyankar for(i=0;i < n; i++) indices[i] = rstart + i; 1450abcba341SShri Abhyankar ierr = ISCreateGeneral(((PetscObject)snes)->comm,n,indices,PETSC_OWN_POINTER,&vi->IS_inact_prev); 1451abcba341SShri Abhyankar } 14522b4ed282SShri Abhyankar 14532f63a38cSShri Abhyankar if (snes->ops->solve == SNESSolveVI_SS) { 1454fe835674SShri Abhyankar ierr = VecDuplicate(snes->vec_sol, &vi->dpsi);CHKERRQ(ierr); 1455fe835674SShri Abhyankar ierr = VecDuplicate(snes->vec_sol, &vi->phi); CHKERRQ(ierr); 1456fe835674SShri Abhyankar ierr = VecDuplicate(snes->vec_sol, &vi->Da); CHKERRQ(ierr); 1457fe835674SShri Abhyankar ierr = VecDuplicate(snes->vec_sol, &vi->Db); CHKERRQ(ierr); 1458fe835674SShri Abhyankar ierr = VecDuplicate(snes->vec_sol, &vi->z);CHKERRQ(ierr); 1459fe835674SShri Abhyankar ierr = VecDuplicate(snes->vec_sol, &vi->t); CHKERRQ(ierr); 1460fe835674SShri Abhyankar } 14612b4ed282SShri Abhyankar PetscFunctionReturn(0); 14622b4ed282SShri Abhyankar } 14632b4ed282SShri Abhyankar /* -------------------------------------------------------------------------- */ 14642b4ed282SShri Abhyankar /* 14652b4ed282SShri Abhyankar SNESDestroy_VI - Destroys the private SNES_VI context that was created 14662b4ed282SShri Abhyankar with SNESCreate_VI(). 14672b4ed282SShri Abhyankar 14682b4ed282SShri Abhyankar Input Parameter: 14692b4ed282SShri Abhyankar . snes - the SNES context 14702b4ed282SShri Abhyankar 14712b4ed282SShri Abhyankar Application Interface Routine: SNESDestroy() 14722b4ed282SShri Abhyankar */ 14732b4ed282SShri Abhyankar #undef __FUNCT__ 14742b4ed282SShri Abhyankar #define __FUNCT__ "SNESDestroy_VI" 14752b4ed282SShri Abhyankar PetscErrorCode SNESDestroy_VI(SNES snes) 14762b4ed282SShri Abhyankar { 14772b4ed282SShri Abhyankar SNES_VI *vi = (SNES_VI*) snes->data; 14782b4ed282SShri Abhyankar PetscErrorCode ierr; 14792b4ed282SShri Abhyankar 14802b4ed282SShri Abhyankar PetscFunctionBegin; 14812f63a38cSShri Abhyankar if (snes->ops->solve != SNESSolveVI_SS) { 14826bf464f9SBarry Smith ierr = ISDestroy(&vi->IS_inact_prev); 1483abcba341SShri Abhyankar } 14842b4ed282SShri Abhyankar 14852f63a38cSShri Abhyankar if (snes->ops->solve == SNESSolveVI_SS) { 14862b4ed282SShri Abhyankar /* clear vectors */ 14876bf464f9SBarry Smith ierr = VecDestroy(&vi->dpsi);CHKERRQ(ierr); 14886bf464f9SBarry Smith ierr = VecDestroy(&vi->phi); CHKERRQ(ierr); 14896bf464f9SBarry Smith ierr = VecDestroy(&vi->Da); CHKERRQ(ierr); 14906bf464f9SBarry Smith ierr = VecDestroy(&vi->Db); CHKERRQ(ierr); 14916bf464f9SBarry Smith ierr = VecDestroy(&vi->z); CHKERRQ(ierr); 14926bf464f9SBarry Smith ierr = VecDestroy(&vi->t); CHKERRQ(ierr); 14937fe79bc4SShri Abhyankar } 14947fe79bc4SShri Abhyankar 14952b4ed282SShri Abhyankar if (!vi->usersetxbounds) { 14966bf464f9SBarry Smith ierr = VecDestroy(&vi->xl); CHKERRQ(ierr); 14976bf464f9SBarry Smith ierr = VecDestroy(&vi->xu); CHKERRQ(ierr); 14982b4ed282SShri Abhyankar } 14997fe79bc4SShri Abhyankar 15006bf464f9SBarry Smith ierr = PetscViewerASCIIMonitorDestroy(&vi->lsmonitor);CHKERRQ(ierr); 15012b4ed282SShri Abhyankar ierr = PetscFree(snes->data);CHKERRQ(ierr); 15022b4ed282SShri Abhyankar 15032b4ed282SShri Abhyankar /* clear composed functions */ 15042b4ed282SShri Abhyankar ierr = PetscObjectComposeFunctionDynamic((PetscObject)snes,"SNESLineSearchSet_C","",PETSC_NULL);CHKERRQ(ierr); 1505c92abb8aSShri Abhyankar ierr = PetscObjectComposeFunctionDynamic((PetscObject)snes,"SNESLineSearchSetMonitor_C","",PETSC_NULL);CHKERRQ(ierr); 15062b4ed282SShri Abhyankar PetscFunctionReturn(0); 15072b4ed282SShri Abhyankar } 15087fe79bc4SShri Abhyankar 15092b4ed282SShri Abhyankar /* -------------------------------------------------------------------------- */ 15102b4ed282SShri Abhyankar #undef __FUNCT__ 15112b4ed282SShri Abhyankar #define __FUNCT__ "SNESLineSearchNo_VI" 15122b4ed282SShri Abhyankar 15132b4ed282SShri Abhyankar /* 15147fe79bc4SShri Abhyankar This routine does not actually do a line search but it takes a full newton 15157fe79bc4SShri Abhyankar step while ensuring that the new iterates remain within the constraints. 15162b4ed282SShri Abhyankar 15172b4ed282SShri Abhyankar */ 1518ace3abfcSBarry Smith PetscErrorCode SNESLineSearchNo_VI(SNES snes,void *lsctx,Vec x,Vec f,Vec g,Vec y,Vec w,PetscReal fnorm,PetscReal xnorm,PetscReal *ynorm,PetscReal *gnorm,PetscBool *flag) 15192b4ed282SShri Abhyankar { 15202b4ed282SShri Abhyankar PetscErrorCode ierr; 15212b4ed282SShri Abhyankar SNES_VI *vi = (SNES_VI*)snes->data; 1522ace3abfcSBarry Smith PetscBool changed_w = PETSC_FALSE,changed_y = PETSC_FALSE; 15232b4ed282SShri Abhyankar 15242b4ed282SShri Abhyankar PetscFunctionBegin; 15252b4ed282SShri Abhyankar *flag = PETSC_TRUE; 15262b4ed282SShri Abhyankar ierr = PetscLogEventBegin(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr); 15272b4ed282SShri Abhyankar ierr = VecNorm(y,NORM_2,ynorm);CHKERRQ(ierr); /* ynorm = || y || */ 15282b4ed282SShri Abhyankar ierr = VecWAXPY(w,-1.0,y,x);CHKERRQ(ierr); /* w <- x - y */ 1529c1a5e521SShri Abhyankar ierr = SNESVIProjectOntoBounds(snes,w);CHKERRQ(ierr); 1530c1a5e521SShri Abhyankar if (vi->postcheckstep) { 1531c1a5e521SShri Abhyankar ierr = (*vi->postcheckstep)(snes,x,y,w,vi->postcheck,&changed_y,&changed_w);CHKERRQ(ierr); 1532c1a5e521SShri Abhyankar } 1533c1a5e521SShri Abhyankar if (changed_y) { 1534c1a5e521SShri Abhyankar ierr = VecWAXPY(w,-1.0,y,x);CHKERRQ(ierr); /* w <- x - y */ 15357fe79bc4SShri Abhyankar ierr = SNESVIProjectOntoBounds(snes,w);CHKERRQ(ierr); 1536c1a5e521SShri Abhyankar } 1537c1a5e521SShri Abhyankar ierr = SNESVIProjectOntoBounds(snes,w);CHKERRQ(ierr); 1538c1a5e521SShri Abhyankar ierr = SNESComputeFunction(snes,w,g);CHKERRQ(ierr); 1539c1a5e521SShri Abhyankar if (!snes->domainerror) { 15402f63a38cSShri Abhyankar if (snes->ops->solve != SNESSolveVI_SS) { 15417fe79bc4SShri Abhyankar ierr = SNESVIComputeInactiveSetFnorm(snes,g,w,gnorm);CHKERRQ(ierr); 15427fe79bc4SShri Abhyankar } else { 1543c1a5e521SShri Abhyankar ierr = VecNorm(g,NORM_2,gnorm);CHKERRQ(ierr); /* gnorm = || g || */ 15447fe79bc4SShri Abhyankar } 154562cbcd01SMatthew G Knepley if (PetscIsInfOrNanReal(*gnorm)) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FP,"User provided compute function generated a Not-a-Number"); 1546c1a5e521SShri Abhyankar } 1547c1a5e521SShri Abhyankar if (vi->lsmonitor) { 1548c1a5e521SShri Abhyankar ierr = PetscViewerASCIIMonitorPrintf(vi->lsmonitor," Line search: Using full step: fnorm %G gnorm %G\n",fnorm,*gnorm);CHKERRQ(ierr); 1549c1a5e521SShri Abhyankar } 1550c1a5e521SShri Abhyankar ierr = PetscLogEventEnd(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr); 1551c1a5e521SShri Abhyankar PetscFunctionReturn(0); 1552c1a5e521SShri Abhyankar } 1553c1a5e521SShri Abhyankar 1554c1a5e521SShri Abhyankar /* -------------------------------------------------------------------------- */ 1555c1a5e521SShri Abhyankar #undef __FUNCT__ 15562b4ed282SShri Abhyankar #define __FUNCT__ "SNESLineSearchNoNorms_VI" 15572b4ed282SShri Abhyankar 15582b4ed282SShri Abhyankar /* 15592b4ed282SShri Abhyankar This routine is a copy of SNESLineSearchNoNorms in snes/impls/ls/ls.c 15602b4ed282SShri Abhyankar */ 1561ace3abfcSBarry Smith PetscErrorCode SNESLineSearchNoNorms_VI(SNES snes,void *lsctx,Vec x,Vec f,Vec g,Vec y,Vec w,PetscReal fnorm,PetscReal xnorm,PetscReal *ynorm,PetscReal *gnorm,PetscBool *flag) 15622b4ed282SShri Abhyankar { 15632b4ed282SShri Abhyankar PetscErrorCode ierr; 15642b4ed282SShri Abhyankar SNES_VI *vi = (SNES_VI*)snes->data; 1565ace3abfcSBarry Smith PetscBool changed_w = PETSC_FALSE,changed_y = PETSC_FALSE; 15662b4ed282SShri Abhyankar 15672b4ed282SShri Abhyankar PetscFunctionBegin; 15682b4ed282SShri Abhyankar *flag = PETSC_TRUE; 15692b4ed282SShri Abhyankar ierr = PetscLogEventBegin(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr); 15702b4ed282SShri Abhyankar ierr = VecWAXPY(w,-1.0,y,x);CHKERRQ(ierr); /* w <- x - y */ 15717fe79bc4SShri Abhyankar ierr = SNESVIProjectOntoBounds(snes,w);CHKERRQ(ierr); 15722b4ed282SShri Abhyankar if (vi->postcheckstep) { 15732b4ed282SShri Abhyankar ierr = (*vi->postcheckstep)(snes,x,y,w,vi->postcheck,&changed_y,&changed_w);CHKERRQ(ierr); 15742b4ed282SShri Abhyankar } 15752b4ed282SShri Abhyankar if (changed_y) { 15762b4ed282SShri Abhyankar ierr = VecWAXPY(w,-1.0,y,x);CHKERRQ(ierr); /* w <- x - y */ 15777fe79bc4SShri Abhyankar ierr = SNESVIProjectOntoBounds(snes,w);CHKERRQ(ierr); 15782b4ed282SShri Abhyankar } 15792b4ed282SShri Abhyankar 15802b4ed282SShri Abhyankar /* don't evaluate function the last time through */ 15812b4ed282SShri Abhyankar if (snes->iter < snes->max_its-1) { 15822b4ed282SShri Abhyankar ierr = SNESComputeFunction(snes,w,g);CHKERRQ(ierr); 15832b4ed282SShri Abhyankar } 15842b4ed282SShri Abhyankar ierr = PetscLogEventEnd(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr); 15852b4ed282SShri Abhyankar PetscFunctionReturn(0); 15862b4ed282SShri Abhyankar } 15877fe79bc4SShri Abhyankar 15882b4ed282SShri Abhyankar /* -------------------------------------------------------------------------- */ 15892b4ed282SShri Abhyankar #undef __FUNCT__ 15902b4ed282SShri Abhyankar #define __FUNCT__ "SNESLineSearchCubic_VI" 15912b4ed282SShri Abhyankar /* 15927fe79bc4SShri Abhyankar This routine implements a cubic line search while doing a projection on the variable bounds 15932b4ed282SShri Abhyankar */ 1594ace3abfcSBarry Smith PetscErrorCode SNESLineSearchCubic_VI(SNES snes,void *lsctx,Vec x,Vec f,Vec g,Vec y,Vec w,PetscReal fnorm,PetscReal xnorm,PetscReal *ynorm,PetscReal *gnorm,PetscBool *flag) 15952b4ed282SShri Abhyankar { 1596fe835674SShri Abhyankar PetscReal initslope,lambdaprev,gnormprev,a,b,d,t1,t2,rellength; 1597fe835674SShri Abhyankar PetscReal minlambda,lambda,lambdatemp; 1598fe835674SShri Abhyankar #if defined(PETSC_USE_COMPLEX) 1599fe835674SShri Abhyankar PetscScalar cinitslope; 1600fe835674SShri Abhyankar #endif 1601fe835674SShri Abhyankar PetscErrorCode ierr; 1602fe835674SShri Abhyankar PetscInt count; 1603fe835674SShri Abhyankar SNES_VI *vi = (SNES_VI*)snes->data; 1604fe835674SShri Abhyankar PetscBool changed_w = PETSC_FALSE,changed_y = PETSC_FALSE; 1605fe835674SShri Abhyankar MPI_Comm comm; 1606fe835674SShri Abhyankar 1607fe835674SShri Abhyankar PetscFunctionBegin; 1608fe835674SShri Abhyankar ierr = PetscObjectGetComm((PetscObject)snes,&comm);CHKERRQ(ierr); 1609fe835674SShri Abhyankar ierr = PetscLogEventBegin(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr); 1610fe835674SShri Abhyankar *flag = PETSC_TRUE; 1611fe835674SShri Abhyankar 1612fe835674SShri Abhyankar ierr = VecNorm(y,NORM_2,ynorm);CHKERRQ(ierr); 1613fe835674SShri Abhyankar if (*ynorm == 0.0) { 1614fe835674SShri Abhyankar if (vi->lsmonitor) { 1615fe835674SShri Abhyankar ierr = PetscViewerASCIIMonitorPrintf(vi->lsmonitor," Line search: Initial direction and size is 0\n");CHKERRQ(ierr); 1616fe835674SShri Abhyankar } 1617fe835674SShri Abhyankar *gnorm = fnorm; 1618fe835674SShri Abhyankar ierr = VecCopy(x,w);CHKERRQ(ierr); 1619fe835674SShri Abhyankar ierr = VecCopy(f,g);CHKERRQ(ierr); 1620fe835674SShri Abhyankar *flag = PETSC_FALSE; 1621fe835674SShri Abhyankar goto theend1; 1622fe835674SShri Abhyankar } 1623fe835674SShri Abhyankar if (*ynorm > vi->maxstep) { /* Step too big, so scale back */ 1624fe835674SShri Abhyankar if (vi->lsmonitor) { 1625fe835674SShri Abhyankar ierr = PetscViewerASCIIMonitorPrintf(vi->lsmonitor," Line search: Scaling step by %G old ynorm %G\n",vi->maxstep/(*ynorm),*ynorm);CHKERRQ(ierr); 1626fe835674SShri Abhyankar } 1627fe835674SShri Abhyankar ierr = VecScale(y,vi->maxstep/(*ynorm));CHKERRQ(ierr); 1628fe835674SShri Abhyankar *ynorm = vi->maxstep; 1629fe835674SShri Abhyankar } 1630fe835674SShri Abhyankar ierr = VecMaxPointwiseDivide(y,x,&rellength);CHKERRQ(ierr); 1631fe835674SShri Abhyankar minlambda = vi->minlambda/rellength; 1632fe835674SShri Abhyankar ierr = MatMult(snes->jacobian,y,w);CHKERRQ(ierr); 1633fe835674SShri Abhyankar #if defined(PETSC_USE_COMPLEX) 1634fe835674SShri Abhyankar ierr = VecDot(f,w,&cinitslope);CHKERRQ(ierr); 1635fe835674SShri Abhyankar initslope = PetscRealPart(cinitslope); 1636fe835674SShri Abhyankar #else 1637fe835674SShri Abhyankar ierr = VecDot(f,w,&initslope);CHKERRQ(ierr); 1638fe835674SShri Abhyankar #endif 1639fe835674SShri Abhyankar if (initslope > 0.0) initslope = -initslope; 1640fe835674SShri Abhyankar if (initslope == 0.0) initslope = -1.0; 1641fe835674SShri Abhyankar 1642fe835674SShri Abhyankar ierr = VecWAXPY(w,-1.0,y,x);CHKERRQ(ierr); 1643fe835674SShri Abhyankar ierr = SNESVIProjectOntoBounds(snes,w);CHKERRQ(ierr); 1644fe835674SShri Abhyankar if (snes->nfuncs >= snes->max_funcs) { 1645fe835674SShri Abhyankar ierr = PetscInfo(snes,"Exceeded maximum function evaluations, while checking full step length!\n");CHKERRQ(ierr); 1646fe835674SShri Abhyankar *flag = PETSC_FALSE; 1647fe835674SShri Abhyankar snes->reason = SNES_DIVERGED_FUNCTION_COUNT; 1648fe835674SShri Abhyankar goto theend1; 1649fe835674SShri Abhyankar } 1650fe835674SShri Abhyankar ierr = SNESComputeFunction(snes,w,g);CHKERRQ(ierr); 16512f63a38cSShri Abhyankar if (snes->ops->solve != SNESSolveVI_SS) { 1652fe835674SShri Abhyankar ierr = SNESVIComputeInactiveSetFnorm(snes,g,w,gnorm);CHKERRQ(ierr); 16537fe79bc4SShri Abhyankar } else { 16547fe79bc4SShri Abhyankar ierr = VecNorm(g,NORM_2,gnorm);CHKERRQ(ierr); 16557fe79bc4SShri Abhyankar } 1656fe835674SShri Abhyankar if (snes->domainerror) { 1657fe835674SShri Abhyankar ierr = PetscLogEventEnd(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr); 1658fe835674SShri Abhyankar PetscFunctionReturn(0); 1659fe835674SShri Abhyankar } 166062cbcd01SMatthew G Knepley if (PetscIsInfOrNanReal(*gnorm)) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FP,"User provided compute function generated a Not-a-Number"); 1661fe835674SShri Abhyankar ierr = PetscInfo2(snes,"Initial fnorm %G gnorm %G\n",fnorm,*gnorm);CHKERRQ(ierr); 1662fe835674SShri Abhyankar if (.5*(*gnorm)*(*gnorm) <= .5*fnorm*fnorm + vi->alpha*initslope) { /* Sufficient reduction */ 1663fe835674SShri Abhyankar if (vi->lsmonitor) { 1664fe835674SShri Abhyankar ierr = PetscViewerASCIIMonitorPrintf(vi->lsmonitor," Line search: Using full step: fnorm %G gnorm %G\n",fnorm,*gnorm);CHKERRQ(ierr); 1665fe835674SShri Abhyankar } 1666fe835674SShri Abhyankar goto theend1; 1667fe835674SShri Abhyankar } 1668fe835674SShri Abhyankar 1669fe835674SShri Abhyankar /* Fit points with quadratic */ 1670fe835674SShri Abhyankar lambda = 1.0; 1671fe835674SShri Abhyankar lambdatemp = -initslope/((*gnorm)*(*gnorm) - fnorm*fnorm - 2.0*initslope); 1672fe835674SShri Abhyankar lambdaprev = lambda; 1673fe835674SShri Abhyankar gnormprev = *gnorm; 1674fe835674SShri Abhyankar if (lambdatemp > .5*lambda) lambdatemp = .5*lambda; 1675fe835674SShri Abhyankar if (lambdatemp <= .1*lambda) lambda = .1*lambda; 1676fe835674SShri Abhyankar else lambda = lambdatemp; 1677fe835674SShri Abhyankar 1678fe835674SShri Abhyankar ierr = VecWAXPY(w,-lambda,y,x);CHKERRQ(ierr); 1679fe835674SShri Abhyankar ierr = SNESVIProjectOntoBounds(snes,w);CHKERRQ(ierr); 1680fe835674SShri Abhyankar if (snes->nfuncs >= snes->max_funcs) { 1681fe835674SShri Abhyankar ierr = PetscInfo1(snes,"Exceeded maximum function evaluations, while attempting quadratic backtracking! %D \n",snes->nfuncs);CHKERRQ(ierr); 1682fe835674SShri Abhyankar *flag = PETSC_FALSE; 1683fe835674SShri Abhyankar snes->reason = SNES_DIVERGED_FUNCTION_COUNT; 1684fe835674SShri Abhyankar goto theend1; 1685fe835674SShri Abhyankar } 1686fe835674SShri Abhyankar ierr = SNESComputeFunction(snes,w,g);CHKERRQ(ierr); 16872f63a38cSShri Abhyankar if (snes->ops->solve != SNESSolveVI_SS) { 1688fe835674SShri Abhyankar ierr = SNESVIComputeInactiveSetFnorm(snes,g,w,gnorm);CHKERRQ(ierr); 16897fe79bc4SShri Abhyankar } else { 16907fe79bc4SShri Abhyankar ierr = VecNorm(g,NORM_2,gnorm);CHKERRQ(ierr); 16917fe79bc4SShri Abhyankar } 1692fe835674SShri Abhyankar if (snes->domainerror) { 1693fe835674SShri Abhyankar ierr = PetscLogEventEnd(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr); 1694fe835674SShri Abhyankar PetscFunctionReturn(0); 1695fe835674SShri Abhyankar } 169662cbcd01SMatthew G Knepley if (PetscIsInfOrNanReal(*gnorm)) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FP,"User provided compute function generated a Not-a-Number"); 1697fe835674SShri Abhyankar if (vi->lsmonitor) { 1698fe835674SShri Abhyankar ierr = PetscViewerASCIIMonitorPrintf(vi->lsmonitor," Line search: gnorm after quadratic fit %G\n",*gnorm);CHKERRQ(ierr); 1699fe835674SShri Abhyankar } 1700fe835674SShri Abhyankar if (.5*(*gnorm)*(*gnorm) < .5*fnorm*fnorm + lambda*vi->alpha*initslope) { /* sufficient reduction */ 1701fe835674SShri Abhyankar if (vi->lsmonitor) { 1702fe835674SShri Abhyankar ierr = PetscViewerASCIIMonitorPrintf(vi->lsmonitor," Line search: Quadratically determined step, lambda=%18.16e\n",lambda);CHKERRQ(ierr); 1703fe835674SShri Abhyankar } 1704fe835674SShri Abhyankar goto theend1; 1705fe835674SShri Abhyankar } 1706fe835674SShri Abhyankar 1707fe835674SShri Abhyankar /* Fit points with cubic */ 1708fe835674SShri Abhyankar count = 1; 1709fe835674SShri Abhyankar while (PETSC_TRUE) { 1710fe835674SShri Abhyankar if (lambda <= minlambda) { 1711fe835674SShri Abhyankar if (vi->lsmonitor) { 1712fe835674SShri Abhyankar ierr = PetscViewerASCIIMonitorPrintf(vi->lsmonitor," Line search: unable to find good step length! After %D tries \n",count);CHKERRQ(ierr); 1713fe835674SShri Abhyankar ierr = PetscViewerASCIIMonitorPrintf(vi->lsmonitor," Line search: fnorm=%18.16e, gnorm=%18.16e, ynorm=%18.16e, minlambda=%18.16e, lambda=%18.16e, initial slope=%18.16e\n",fnorm,*gnorm,*ynorm,minlambda,lambda,initslope);CHKERRQ(ierr); 1714fe835674SShri Abhyankar } 1715fe835674SShri Abhyankar *flag = PETSC_FALSE; 1716fe835674SShri Abhyankar break; 1717fe835674SShri Abhyankar } 1718fe835674SShri Abhyankar t1 = .5*((*gnorm)*(*gnorm) - fnorm*fnorm) - lambda*initslope; 1719fe835674SShri Abhyankar t2 = .5*(gnormprev*gnormprev - fnorm*fnorm) - lambdaprev*initslope; 1720fe835674SShri Abhyankar a = (t1/(lambda*lambda) - t2/(lambdaprev*lambdaprev))/(lambda-lambdaprev); 1721fe835674SShri Abhyankar b = (-lambdaprev*t1/(lambda*lambda) + lambda*t2/(lambdaprev*lambdaprev))/(lambda-lambdaprev); 1722fe835674SShri Abhyankar d = b*b - 3*a*initslope; 1723fe835674SShri Abhyankar if (d < 0.0) d = 0.0; 1724fe835674SShri Abhyankar if (a == 0.0) { 1725fe835674SShri Abhyankar lambdatemp = -initslope/(2.0*b); 1726fe835674SShri Abhyankar } else { 1727fe835674SShri Abhyankar lambdatemp = (-b + sqrt(d))/(3.0*a); 1728fe835674SShri Abhyankar } 1729fe835674SShri Abhyankar lambdaprev = lambda; 1730fe835674SShri Abhyankar gnormprev = *gnorm; 1731fe835674SShri Abhyankar if (lambdatemp > .5*lambda) lambdatemp = .5*lambda; 1732fe835674SShri Abhyankar if (lambdatemp <= .1*lambda) lambda = .1*lambda; 1733fe835674SShri Abhyankar else lambda = lambdatemp; 1734fe835674SShri Abhyankar ierr = VecWAXPY(w,-lambda,y,x);CHKERRQ(ierr); 1735fe835674SShri Abhyankar ierr = SNESVIProjectOntoBounds(snes,w);CHKERRQ(ierr); 1736fe835674SShri Abhyankar if (snes->nfuncs >= snes->max_funcs) { 1737fe835674SShri Abhyankar ierr = PetscInfo1(snes,"Exceeded maximum function evaluations, while looking for good step length! %D \n",count);CHKERRQ(ierr); 1738fe835674SShri Abhyankar ierr = PetscInfo5(snes,"fnorm=%18.16e, gnorm=%18.16e, ynorm=%18.16e, lambda=%18.16e, initial slope=%18.16e\n",fnorm,*gnorm,*ynorm,lambda,initslope);CHKERRQ(ierr); 1739fe835674SShri Abhyankar *flag = PETSC_FALSE; 1740fe835674SShri Abhyankar snes->reason = SNES_DIVERGED_FUNCTION_COUNT; 1741fe835674SShri Abhyankar break; 1742fe835674SShri Abhyankar } 1743fe835674SShri Abhyankar ierr = SNESComputeFunction(snes,w,g);CHKERRQ(ierr); 17442f63a38cSShri Abhyankar if (snes->ops->solve != SNESSolveVI_SS) { 1745fe835674SShri Abhyankar ierr = SNESVIComputeInactiveSetFnorm(snes,g,w,gnorm);CHKERRQ(ierr); 17467fe79bc4SShri Abhyankar } else { 17477fe79bc4SShri Abhyankar ierr = VecNorm(g,NORM_2,gnorm);CHKERRQ(ierr); 17487fe79bc4SShri Abhyankar } 1749fe835674SShri Abhyankar if (snes->domainerror) { 1750fe835674SShri Abhyankar ierr = PetscLogEventEnd(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr); 1751fe835674SShri Abhyankar PetscFunctionReturn(0); 1752fe835674SShri Abhyankar } 175362cbcd01SMatthew G Knepley if (PetscIsInfOrNanReal(*gnorm)) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FP,"User provided compute function generated a Not-a-Number"); 1754fe835674SShri Abhyankar if (.5*(*gnorm)*(*gnorm) < .5*fnorm*fnorm + lambda*vi->alpha*initslope) { /* is reduction enough? */ 1755fe835674SShri Abhyankar if (vi->lsmonitor) { 1756fe835674SShri Abhyankar ierr = PetscPrintf(comm," Line search: Cubically determined step, current gnorm %G lambda=%18.16e\n",*gnorm,lambda);CHKERRQ(ierr); 1757fe835674SShri Abhyankar } 1758fe835674SShri Abhyankar break; 1759fe835674SShri Abhyankar } else { 1760fe835674SShri Abhyankar if (vi->lsmonitor) { 1761fe835674SShri Abhyankar ierr = PetscPrintf(comm," Line search: Cubic step no good, shrinking lambda, current gnorm %G lambda=%18.16e\n",*gnorm,lambda);CHKERRQ(ierr); 1762fe835674SShri Abhyankar } 1763fe835674SShri Abhyankar } 1764fe835674SShri Abhyankar count++; 1765fe835674SShri Abhyankar } 1766fe835674SShri Abhyankar theend1: 1767fe835674SShri Abhyankar /* Optional user-defined check for line search step validity */ 1768fe835674SShri Abhyankar if (vi->postcheckstep && *flag) { 1769fe835674SShri Abhyankar ierr = (*vi->postcheckstep)(snes,x,y,w,vi->postcheck,&changed_y,&changed_w);CHKERRQ(ierr); 1770fe835674SShri Abhyankar if (changed_y) { 1771fe835674SShri Abhyankar ierr = VecWAXPY(w,-1.0,y,x);CHKERRQ(ierr); 1772fe835674SShri Abhyankar ierr = SNESVIProjectOntoBounds(snes,w);CHKERRQ(ierr); 1773fe835674SShri Abhyankar } 1774fe835674SShri Abhyankar if (changed_y || changed_w) { /* recompute the function if the step has changed */ 1775fe835674SShri Abhyankar ierr = SNESComputeFunction(snes,w,g);CHKERRQ(ierr); 17762f63a38cSShri Abhyankar if (snes->ops->solve != SNESSolveVI_SS) { 1777fe835674SShri Abhyankar ierr = SNESVIComputeInactiveSetFnorm(snes,g,w,gnorm);CHKERRQ(ierr); 17787fe79bc4SShri Abhyankar } else { 17797fe79bc4SShri Abhyankar ierr = VecNorm(g,NORM_2,gnorm);CHKERRQ(ierr); 17807fe79bc4SShri Abhyankar } 1781fe835674SShri Abhyankar if (snes->domainerror) { 1782fe835674SShri Abhyankar ierr = PetscLogEventEnd(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr); 1783fe835674SShri Abhyankar PetscFunctionReturn(0); 1784fe835674SShri Abhyankar } 178562cbcd01SMatthew G Knepley if (PetscIsInfOrNanReal(*gnorm)) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FP,"User provided compute function generated a Not-a-Number"); 1786fe835674SShri Abhyankar ierr = VecNormBegin(y,NORM_2,ynorm);CHKERRQ(ierr); 1787fe835674SShri Abhyankar ierr = VecNormEnd(y,NORM_2,ynorm);CHKERRQ(ierr); 1788fe835674SShri Abhyankar } 1789fe835674SShri Abhyankar } 1790fe835674SShri Abhyankar ierr = PetscLogEventEnd(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr); 1791fe835674SShri Abhyankar PetscFunctionReturn(0); 1792fe835674SShri Abhyankar } 1793fe835674SShri Abhyankar 17942b4ed282SShri Abhyankar #undef __FUNCT__ 17952b4ed282SShri Abhyankar #define __FUNCT__ "SNESLineSearchQuadratic_VI" 17962b4ed282SShri Abhyankar /* 17977fe79bc4SShri Abhyankar This routine does a quadratic line search while keeping the iterates within the variable bounds 17982b4ed282SShri Abhyankar */ 1799ace3abfcSBarry Smith PetscErrorCode SNESLineSearchQuadratic_VI(SNES snes,void *lsctx,Vec x,Vec f,Vec g,Vec y,Vec w,PetscReal fnorm,PetscReal xnorm,PetscReal *ynorm,PetscReal *gnorm,PetscBool *flag) 18002b4ed282SShri Abhyankar { 18012b4ed282SShri Abhyankar /* 18022b4ed282SShri Abhyankar Note that for line search purposes we work with with the related 18032b4ed282SShri Abhyankar minimization problem: 18042b4ed282SShri Abhyankar min z(x): R^n -> R, 18052b4ed282SShri Abhyankar where z(x) = .5 * fnorm*fnorm,and fnorm = || f ||_2. 18062b4ed282SShri Abhyankar */ 18072b4ed282SShri Abhyankar PetscReal initslope,minlambda,lambda,lambdatemp,rellength; 18082b4ed282SShri Abhyankar #if defined(PETSC_USE_COMPLEX) 18092b4ed282SShri Abhyankar PetscScalar cinitslope; 18102b4ed282SShri Abhyankar #endif 18112b4ed282SShri Abhyankar PetscErrorCode ierr; 18122b4ed282SShri Abhyankar PetscInt count; 18132b4ed282SShri Abhyankar SNES_VI *vi = (SNES_VI*)snes->data; 1814ace3abfcSBarry Smith PetscBool changed_w = PETSC_FALSE,changed_y = PETSC_FALSE; 18152b4ed282SShri Abhyankar 18162b4ed282SShri Abhyankar PetscFunctionBegin; 18172b4ed282SShri Abhyankar ierr = PetscLogEventBegin(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr); 18182b4ed282SShri Abhyankar *flag = PETSC_TRUE; 18192b4ed282SShri Abhyankar 18202b4ed282SShri Abhyankar ierr = VecNorm(y,NORM_2,ynorm);CHKERRQ(ierr); 18212b4ed282SShri Abhyankar if (*ynorm == 0.0) { 1822c92abb8aSShri Abhyankar if (vi->lsmonitor) { 1823c92abb8aSShri Abhyankar ierr = PetscViewerASCIIMonitorPrintf(vi->lsmonitor,"Line search: Direction and size is 0\n");CHKERRQ(ierr); 18242b4ed282SShri Abhyankar } 18252b4ed282SShri Abhyankar *gnorm = fnorm; 18262b4ed282SShri Abhyankar ierr = VecCopy(x,w);CHKERRQ(ierr); 18272b4ed282SShri Abhyankar ierr = VecCopy(f,g);CHKERRQ(ierr); 18282b4ed282SShri Abhyankar *flag = PETSC_FALSE; 18292b4ed282SShri Abhyankar goto theend2; 18302b4ed282SShri Abhyankar } 18312b4ed282SShri Abhyankar if (*ynorm > vi->maxstep) { /* Step too big, so scale back */ 18322b4ed282SShri Abhyankar ierr = VecScale(y,vi->maxstep/(*ynorm));CHKERRQ(ierr); 18332b4ed282SShri Abhyankar *ynorm = vi->maxstep; 18342b4ed282SShri Abhyankar } 18352b4ed282SShri Abhyankar ierr = VecMaxPointwiseDivide(y,x,&rellength);CHKERRQ(ierr); 18362b4ed282SShri Abhyankar minlambda = vi->minlambda/rellength; 18377fe79bc4SShri Abhyankar ierr = MatMult(snes->jacobian,y,w);CHKERRQ(ierr); 18382b4ed282SShri Abhyankar #if defined(PETSC_USE_COMPLEX) 18397fe79bc4SShri Abhyankar ierr = VecDot(f,w,&cinitslope);CHKERRQ(ierr); 18402b4ed282SShri Abhyankar initslope = PetscRealPart(cinitslope); 18412b4ed282SShri Abhyankar #else 18427fe79bc4SShri Abhyankar ierr = VecDot(f,w,&initslope);CHKERRQ(ierr); 18432b4ed282SShri Abhyankar #endif 18442b4ed282SShri Abhyankar if (initslope > 0.0) initslope = -initslope; 18452b4ed282SShri Abhyankar if (initslope == 0.0) initslope = -1.0; 18462b4ed282SShri Abhyankar ierr = PetscInfo1(snes,"Initslope %G \n",initslope);CHKERRQ(ierr); 18472b4ed282SShri Abhyankar 18482b4ed282SShri Abhyankar ierr = VecWAXPY(w,-1.0,y,x);CHKERRQ(ierr); 18497fe79bc4SShri Abhyankar ierr = SNESVIProjectOntoBounds(snes,w);CHKERRQ(ierr); 18502b4ed282SShri Abhyankar if (snes->nfuncs >= snes->max_funcs) { 18512b4ed282SShri Abhyankar ierr = PetscInfo(snes,"Exceeded maximum function evaluations, while checking full step length!\n");CHKERRQ(ierr); 18522b4ed282SShri Abhyankar *flag = PETSC_FALSE; 18532b4ed282SShri Abhyankar snes->reason = SNES_DIVERGED_FUNCTION_COUNT; 18542b4ed282SShri Abhyankar goto theend2; 18552b4ed282SShri Abhyankar } 18562b4ed282SShri Abhyankar ierr = SNESComputeFunction(snes,w,g);CHKERRQ(ierr); 18572f63a38cSShri Abhyankar if (snes->ops->solve != SNESSolveVI_SS) { 18587fe79bc4SShri Abhyankar ierr = SNESVIComputeInactiveSetFnorm(snes,g,w,gnorm);CHKERRQ(ierr); 18597fe79bc4SShri Abhyankar } else { 18607fe79bc4SShri Abhyankar ierr = VecNorm(g,NORM_2,gnorm);CHKERRQ(ierr); 18617fe79bc4SShri Abhyankar } 18622b4ed282SShri Abhyankar if (snes->domainerror) { 18632b4ed282SShri Abhyankar ierr = PetscLogEventEnd(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr); 18642b4ed282SShri Abhyankar PetscFunctionReturn(0); 18652b4ed282SShri Abhyankar } 186662cbcd01SMatthew G Knepley if (PetscIsInfOrNanReal(*gnorm)) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FP,"User provided compute function generated a Not-a-Number"); 18672b4ed282SShri Abhyankar if (.5*(*gnorm)*(*gnorm) <= .5*fnorm*fnorm + vi->alpha*initslope) { /* Sufficient reduction */ 1868c92abb8aSShri Abhyankar if (vi->lsmonitor) { 1869c92abb8aSShri Abhyankar ierr = PetscViewerASCIIMonitorPrintf(vi->lsmonitor," Line search: Using full step: fnorm %G gnorm %G\n",fnorm,*gnorm);CHKERRQ(ierr); 18702b4ed282SShri Abhyankar } 18712b4ed282SShri Abhyankar goto theend2; 18722b4ed282SShri Abhyankar } 18732b4ed282SShri Abhyankar 18742b4ed282SShri Abhyankar /* Fit points with quadratic */ 18752b4ed282SShri Abhyankar lambda = 1.0; 18762b4ed282SShri Abhyankar count = 1; 18772b4ed282SShri Abhyankar while (PETSC_TRUE) { 18782b4ed282SShri Abhyankar if (lambda <= minlambda) { /* bad luck; use full step */ 1879c92abb8aSShri Abhyankar if (vi->lsmonitor) { 1880c92abb8aSShri Abhyankar ierr = PetscViewerASCIIMonitorPrintf(vi->lsmonitor,"Line search: Unable to find good step length! %D \n",count);CHKERRQ(ierr); 1881c92abb8aSShri Abhyankar ierr = PetscViewerASCIIMonitorPrintf(vi->lsmonitor,"Line search: fnorm=%G, gnorm=%G, ynorm=%G, lambda=%G, initial slope=%G\n",fnorm,*gnorm,*ynorm,lambda,initslope);CHKERRQ(ierr); 18822b4ed282SShri Abhyankar } 18832b4ed282SShri Abhyankar ierr = VecCopy(x,w);CHKERRQ(ierr); 18842b4ed282SShri Abhyankar *flag = PETSC_FALSE; 18852b4ed282SShri Abhyankar break; 18862b4ed282SShri Abhyankar } 18872b4ed282SShri Abhyankar lambdatemp = -initslope/((*gnorm)*(*gnorm) - fnorm*fnorm - 2.0*initslope); 18882b4ed282SShri Abhyankar if (lambdatemp > .5*lambda) lambdatemp = .5*lambda; 18892b4ed282SShri Abhyankar if (lambdatemp <= .1*lambda) lambda = .1*lambda; 18902b4ed282SShri Abhyankar else lambda = lambdatemp; 18912b4ed282SShri Abhyankar 18922b4ed282SShri Abhyankar ierr = VecWAXPY(w,-lambda,y,x);CHKERRQ(ierr); 18937fe79bc4SShri Abhyankar ierr = SNESVIProjectOntoBounds(snes,w);CHKERRQ(ierr); 18942b4ed282SShri Abhyankar if (snes->nfuncs >= snes->max_funcs) { 18952b4ed282SShri Abhyankar ierr = PetscInfo1(snes,"Exceeded maximum function evaluations, while looking for good step length! %D \n",count);CHKERRQ(ierr); 18962b4ed282SShri Abhyankar ierr = PetscInfo5(snes,"fnorm=%18.16e, gnorm=%18.16e, ynorm=%18.16e, lambda=%18.16e, initial slope=%18.16e\n",fnorm,*gnorm,*ynorm,lambda,initslope);CHKERRQ(ierr); 18972b4ed282SShri Abhyankar *flag = PETSC_FALSE; 18982b4ed282SShri Abhyankar snes->reason = SNES_DIVERGED_FUNCTION_COUNT; 18992b4ed282SShri Abhyankar break; 19002b4ed282SShri Abhyankar } 19012b4ed282SShri Abhyankar ierr = SNESComputeFunction(snes,w,g);CHKERRQ(ierr); 19022b4ed282SShri Abhyankar if (snes->domainerror) { 19032b4ed282SShri Abhyankar ierr = PetscLogEventEnd(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr); 19042b4ed282SShri Abhyankar PetscFunctionReturn(0); 19052b4ed282SShri Abhyankar } 19062f63a38cSShri Abhyankar if (snes->ops->solve != SNESSolveVI_SS) { 19077fe79bc4SShri Abhyankar ierr = SNESVIComputeInactiveSetFnorm(snes,g,w,gnorm);CHKERRQ(ierr); 19087fe79bc4SShri Abhyankar } else { 19092b4ed282SShri Abhyankar ierr = VecNorm(g,NORM_2,gnorm);CHKERRQ(ierr); 19107fe79bc4SShri Abhyankar } 191162cbcd01SMatthew G Knepley if (PetscIsInfOrNanReal(*gnorm)) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FP,"User provided compute function generated a Not-a-Number"); 19122b4ed282SShri Abhyankar if (.5*(*gnorm)*(*gnorm) < .5*fnorm*fnorm + lambda*vi->alpha*initslope) { /* sufficient reduction */ 1913c92abb8aSShri Abhyankar if (vi->lsmonitor) { 1914c92abb8aSShri Abhyankar ierr = PetscViewerASCIIMonitorPrintf(vi->lsmonitor," Line Search: Quadratically determined step, lambda=%G\n",lambda);CHKERRQ(ierr); 19152b4ed282SShri Abhyankar } 19162b4ed282SShri Abhyankar break; 19172b4ed282SShri Abhyankar } 19182b4ed282SShri Abhyankar count++; 19192b4ed282SShri Abhyankar } 19202b4ed282SShri Abhyankar theend2: 19212b4ed282SShri Abhyankar /* Optional user-defined check for line search step validity */ 19222b4ed282SShri Abhyankar if (vi->postcheckstep) { 19232b4ed282SShri Abhyankar ierr = (*vi->postcheckstep)(snes,x,y,w,vi->postcheck,&changed_y,&changed_w);CHKERRQ(ierr); 19242b4ed282SShri Abhyankar if (changed_y) { 19252b4ed282SShri Abhyankar ierr = VecWAXPY(w,-1.0,y,x);CHKERRQ(ierr); 19267fe79bc4SShri Abhyankar ierr = SNESVIProjectOntoBounds(snes,w);CHKERRQ(ierr); 19272b4ed282SShri Abhyankar } 19282b4ed282SShri Abhyankar if (changed_y || changed_w) { /* recompute the function if the step has changed */ 19292b4ed282SShri Abhyankar ierr = SNESComputeFunction(snes,w,g); 19302b4ed282SShri Abhyankar if (snes->domainerror) { 19312b4ed282SShri Abhyankar ierr = PetscLogEventEnd(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr); 19322b4ed282SShri Abhyankar PetscFunctionReturn(0); 19332b4ed282SShri Abhyankar } 19342f63a38cSShri Abhyankar if (snes->ops->solve != SNESSolveVI_SS) { 19357fe79bc4SShri Abhyankar ierr = SNESVIComputeInactiveSetFnorm(snes,g,w,gnorm);CHKERRQ(ierr); 19367fe79bc4SShri Abhyankar } else { 19377fe79bc4SShri Abhyankar ierr = VecNorm(g,NORM_2,gnorm);CHKERRQ(ierr); 19387fe79bc4SShri Abhyankar } 19397fe79bc4SShri Abhyankar 19402b4ed282SShri Abhyankar ierr = VecNormBegin(y,NORM_2,ynorm);CHKERRQ(ierr); 19412b4ed282SShri Abhyankar ierr = VecNormEnd(y,NORM_2,ynorm);CHKERRQ(ierr); 194262cbcd01SMatthew G Knepley if (PetscIsInfOrNanReal(*gnorm)) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FP,"User provided compute function generated a Not-a-Number"); 19432b4ed282SShri Abhyankar } 19442b4ed282SShri Abhyankar } 19452b4ed282SShri Abhyankar ierr = PetscLogEventEnd(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr); 19462b4ed282SShri Abhyankar PetscFunctionReturn(0); 19472b4ed282SShri Abhyankar } 19482b4ed282SShri Abhyankar 1949ace3abfcSBarry Smith typedef PetscErrorCode (*FCN2)(SNES,void*,Vec,Vec,Vec,Vec,Vec,PetscReal,PetscReal,PetscReal*,PetscReal*,PetscBool*); /* force argument to next function to not be extern C*/ 19502b4ed282SShri Abhyankar /* -------------------------------------------------------------------------- */ 19512b4ed282SShri Abhyankar EXTERN_C_BEGIN 19522b4ed282SShri Abhyankar #undef __FUNCT__ 19532b4ed282SShri Abhyankar #define __FUNCT__ "SNESLineSearchSet_VI" 19547087cfbeSBarry Smith PetscErrorCode SNESLineSearchSet_VI(SNES snes,FCN2 func,void *lsctx) 19552b4ed282SShri Abhyankar { 19562b4ed282SShri Abhyankar PetscFunctionBegin; 19572b4ed282SShri Abhyankar ((SNES_VI *)(snes->data))->LineSearch = func; 19582b4ed282SShri Abhyankar ((SNES_VI *)(snes->data))->lsP = lsctx; 19592b4ed282SShri Abhyankar PetscFunctionReturn(0); 19602b4ed282SShri Abhyankar } 19612b4ed282SShri Abhyankar EXTERN_C_END 19622b4ed282SShri Abhyankar 19632b4ed282SShri Abhyankar /* -------------------------------------------------------------------------- */ 19642b4ed282SShri Abhyankar EXTERN_C_BEGIN 19652b4ed282SShri Abhyankar #undef __FUNCT__ 19662b4ed282SShri Abhyankar #define __FUNCT__ "SNESLineSearchSetMonitor_VI" 19677087cfbeSBarry Smith PetscErrorCode SNESLineSearchSetMonitor_VI(SNES snes,PetscBool flg) 19682b4ed282SShri Abhyankar { 19692b4ed282SShri Abhyankar SNES_VI *vi = (SNES_VI*)snes->data; 19702b4ed282SShri Abhyankar PetscErrorCode ierr; 19712b4ed282SShri Abhyankar 19722b4ed282SShri Abhyankar PetscFunctionBegin; 1973c92abb8aSShri Abhyankar if (flg && !vi->lsmonitor) { 1974c92abb8aSShri Abhyankar ierr = PetscViewerASCIIMonitorCreate(((PetscObject)snes)->comm,"stdout",((PetscObject)snes)->tablevel,&vi->lsmonitor);CHKERRQ(ierr); 1975c92abb8aSShri Abhyankar } else if (!flg && vi->lsmonitor) { 19766bf464f9SBarry Smith ierr = PetscViewerASCIIMonitorDestroy(&vi->lsmonitor);CHKERRQ(ierr); 19772b4ed282SShri Abhyankar } 19782b4ed282SShri Abhyankar PetscFunctionReturn(0); 19792b4ed282SShri Abhyankar } 19802b4ed282SShri Abhyankar EXTERN_C_END 19812b4ed282SShri Abhyankar 19822b4ed282SShri Abhyankar /* 19832b4ed282SShri Abhyankar SNESView_VI - Prints info from the SNESVI data structure. 19842b4ed282SShri Abhyankar 19852b4ed282SShri Abhyankar Input Parameters: 19862b4ed282SShri Abhyankar . SNES - the SNES context 19872b4ed282SShri Abhyankar . viewer - visualization context 19882b4ed282SShri Abhyankar 19892b4ed282SShri Abhyankar Application Interface Routine: SNESView() 19902b4ed282SShri Abhyankar */ 19912b4ed282SShri Abhyankar #undef __FUNCT__ 19922b4ed282SShri Abhyankar #define __FUNCT__ "SNESView_VI" 19932b4ed282SShri Abhyankar static PetscErrorCode SNESView_VI(SNES snes,PetscViewer viewer) 19942b4ed282SShri Abhyankar { 19952b4ed282SShri Abhyankar SNES_VI *vi = (SNES_VI *)snes->data; 199678c4b9d3SShri Abhyankar const char *cstr,*tstr; 19972b4ed282SShri Abhyankar PetscErrorCode ierr; 1998ace3abfcSBarry Smith PetscBool iascii; 19992b4ed282SShri Abhyankar 20002b4ed282SShri Abhyankar PetscFunctionBegin; 20012b4ed282SShri Abhyankar ierr = PetscTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr); 20022b4ed282SShri Abhyankar if (iascii) { 20032b4ed282SShri Abhyankar if (vi->LineSearch == SNESLineSearchNo_VI) cstr = "SNESLineSearchNo"; 20042b4ed282SShri Abhyankar else if (vi->LineSearch == SNESLineSearchQuadratic_VI) cstr = "SNESLineSearchQuadratic"; 20052b4ed282SShri Abhyankar else if (vi->LineSearch == SNESLineSearchCubic_VI) cstr = "SNESLineSearchCubic"; 20062b4ed282SShri Abhyankar else cstr = "unknown"; 200778c4b9d3SShri Abhyankar if (snes->ops->solve == SNESSolveVI_SS) tstr = "Semismooth"; 20080a7c7af0SShri Abhyankar else if (snes->ops->solve == SNESSolveVI_RS) tstr = "Reduced Space"; 20092f63a38cSShri Abhyankar else if (snes->ops->solve == SNESSolveVI_RS2) tstr = "Augmented Space"; 201078c4b9d3SShri Abhyankar else tstr = "unknown"; 201178c4b9d3SShri Abhyankar ierr = PetscViewerASCIIPrintf(viewer," VI algorithm: %s\n",tstr);CHKERRQ(ierr); 20122b4ed282SShri Abhyankar ierr = PetscViewerASCIIPrintf(viewer," line search variant: %s\n",cstr);CHKERRQ(ierr); 20132b4ed282SShri Abhyankar ierr = PetscViewerASCIIPrintf(viewer," alpha=%G, maxstep=%G, minlambda=%G\n",vi->alpha,vi->maxstep,vi->minlambda);CHKERRQ(ierr); 20142b4ed282SShri Abhyankar } else { 20152b4ed282SShri Abhyankar SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Viewer type %s not supported for SNES EQ VI",((PetscObject)viewer)->type_name); 20162b4ed282SShri Abhyankar } 20172b4ed282SShri Abhyankar PetscFunctionReturn(0); 20182b4ed282SShri Abhyankar } 20192b4ed282SShri Abhyankar 20205559b345SBarry Smith #undef __FUNCT__ 20215559b345SBarry Smith #define __FUNCT__ "SNESVISetVariableBounds" 20225559b345SBarry Smith /*@ 20232b4ed282SShri Abhyankar SNESVISetVariableBounds - Sets the lower and upper bounds for the solution vector. xl <= x <= xu. 20242b4ed282SShri Abhyankar 20252b4ed282SShri Abhyankar Input Parameters: 20262b4ed282SShri Abhyankar . snes - the SNES context. 20272b4ed282SShri Abhyankar . xl - lower bound. 20282b4ed282SShri Abhyankar . xu - upper bound. 20292b4ed282SShri Abhyankar 20302b4ed282SShri Abhyankar Notes: 20312b4ed282SShri Abhyankar If this routine is not called then the lower and upper bounds are set to 203284c105d7SBarry Smith PETSC_VI_INF and PETSC_VI_NINF respectively during SNESSetUp(). 203384c105d7SBarry Smith 20345559b345SBarry Smith @*/ 203569c03620SShri Abhyankar PetscErrorCode SNESVISetVariableBounds(SNES snes, Vec xl, Vec xu) 20362b4ed282SShri Abhyankar { 20372b4ed282SShri Abhyankar SNES_VI *vi = (SNES_VI*)snes->data; 20382b4ed282SShri Abhyankar 20392b4ed282SShri Abhyankar PetscFunctionBegin; 20402b4ed282SShri Abhyankar PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 20412b4ed282SShri Abhyankar PetscValidHeaderSpecific(xl,VEC_CLASSID,2); 20422b4ed282SShri Abhyankar PetscValidHeaderSpecific(xu,VEC_CLASSID,3); 20432b4ed282SShri Abhyankar if (!snes->vec_func) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call SNESSetFunction() first"); 20442b4ed282SShri Abhyankar if (xl->map->N != snes->vec_func->map->N) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_INCOMP,"Incompatible vector lengths lower bound = %D solution vector = %D",xl->map->N,snes->vec_func->map->N); 20452b4ed282SShri Abhyankar if (xu->map->N != snes->vec_func->map->N) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_INCOMP,"Incompatible vector lengths: upper bound = %D solution vector = %D",xu->map->N,snes->vec_func->map->N); 20465559b345SBarry Smith 20472b4ed282SShri Abhyankar vi->usersetxbounds = PETSC_TRUE; 20482b4ed282SShri Abhyankar vi->xl = xl; 20492b4ed282SShri Abhyankar vi->xu = xu; 20502b4ed282SShri Abhyankar PetscFunctionReturn(0); 20512b4ed282SShri Abhyankar } 2052693ddf92SShri Abhyankar 20532b4ed282SShri Abhyankar /* -------------------------------------------------------------------------- */ 20542b4ed282SShri Abhyankar /* 20552b4ed282SShri Abhyankar SNESSetFromOptions_VI - Sets various parameters for the SNESVI method. 20562b4ed282SShri Abhyankar 20572b4ed282SShri Abhyankar Input Parameter: 20582b4ed282SShri Abhyankar . snes - the SNES context 20592b4ed282SShri Abhyankar 20602b4ed282SShri Abhyankar Application Interface Routine: SNESSetFromOptions() 20612b4ed282SShri Abhyankar */ 20622b4ed282SShri Abhyankar #undef __FUNCT__ 20632b4ed282SShri Abhyankar #define __FUNCT__ "SNESSetFromOptions_VI" 20642b4ed282SShri Abhyankar static PetscErrorCode SNESSetFromOptions_VI(SNES snes) 20652b4ed282SShri Abhyankar { 20662b4ed282SShri Abhyankar SNES_VI *vi = (SNES_VI *)snes->data; 20677fe79bc4SShri Abhyankar const char *lses[] = {"basic","basicnonorms","quadratic","cubic"}; 20682f63a38cSShri Abhyankar const char *vies[] = {"ss","rs","rs2"}; 20692b4ed282SShri Abhyankar PetscErrorCode ierr; 20702b4ed282SShri Abhyankar PetscInt indx; 207169c03620SShri Abhyankar PetscBool flg,set,flg2; 20722b4ed282SShri Abhyankar 20732b4ed282SShri Abhyankar PetscFunctionBegin; 20742b4ed282SShri Abhyankar ierr = PetscOptionsHead("SNES semismooth method options");CHKERRQ(ierr); 20759308c137SBarry Smith ierr = PetscOptionsBool("-snes_vi_monitor","Monitor all non-active variables","None",PETSC_FALSE,&flg,0);CHKERRQ(ierr); 20769308c137SBarry Smith if (flg) { 20779308c137SBarry Smith ierr = SNESMonitorSet(snes,SNESMonitorVI,0,0);CHKERRQ(ierr); 20789308c137SBarry Smith } 2079be6adb11SBarry Smith ierr = PetscOptionsReal("-snes_ls_alpha","Function norm must decrease by","None",vi->alpha,&vi->alpha,0);CHKERRQ(ierr); 2080be6adb11SBarry Smith ierr = PetscOptionsReal("-snes_ls_maxstep","Step must be less than","None",vi->maxstep,&vi->maxstep,0);CHKERRQ(ierr); 2081be6adb11SBarry Smith ierr = PetscOptionsReal("-snes_ls_minlambda","Minimum lambda allowed","None",vi->minlambda,&vi->minlambda,0);CHKERRQ(ierr); 20822b4ed282SShri Abhyankar ierr = PetscOptionsReal("-snes_vi_const_tol","constraint tolerance","None",vi->const_tol,&vi->const_tol,0);CHKERRQ(ierr); 2083be6adb11SBarry Smith ierr = PetscOptionsBool("-snes_ls_monitor","Print progress of line searches","SNESLineSearchSetMonitor",vi->lsmonitor ? PETSC_TRUE : PETSC_FALSE,&flg,&set);CHKERRQ(ierr); 20842b4ed282SShri Abhyankar if (set) {ierr = SNESLineSearchSetMonitor(snes,flg);CHKERRQ(ierr);} 20852f63a38cSShri Abhyankar ierr = PetscOptionsEList("-snes_vi_type","Semismooth algorithm used","",vies,3,"ss",&indx,&flg2);CHKERRQ(ierr); 208669c03620SShri Abhyankar if (flg2) { 208769c03620SShri Abhyankar switch (indx) { 208869c03620SShri Abhyankar case 0: 208969c03620SShri Abhyankar snes->ops->solve = SNESSolveVI_SS; 209069c03620SShri Abhyankar break; 209169c03620SShri Abhyankar case 1: 2092d950fb63SShri Abhyankar snes->ops->solve = SNESSolveVI_RS; 2093d950fb63SShri Abhyankar break; 20942f63a38cSShri Abhyankar case 2: 20952f63a38cSShri Abhyankar snes->ops->solve = SNESSolveVI_RS2; 209669c03620SShri Abhyankar } 209769c03620SShri Abhyankar } 2098be6adb11SBarry Smith ierr = PetscOptionsEList("-snes_ls","Line search used","SNESLineSearchSet",lses,4,"basic",&indx,&flg);CHKERRQ(ierr); 20992b4ed282SShri Abhyankar if (flg) { 21002b4ed282SShri Abhyankar switch (indx) { 21012b4ed282SShri Abhyankar case 0: 21022b4ed282SShri Abhyankar ierr = SNESLineSearchSet(snes,SNESLineSearchNo_VI,PETSC_NULL);CHKERRQ(ierr); 21032b4ed282SShri Abhyankar break; 21042b4ed282SShri Abhyankar case 1: 21052b4ed282SShri Abhyankar ierr = SNESLineSearchSet(snes,SNESLineSearchNoNorms_VI,PETSC_NULL);CHKERRQ(ierr); 21062b4ed282SShri Abhyankar break; 21072b4ed282SShri Abhyankar case 2: 21082b4ed282SShri Abhyankar ierr = SNESLineSearchSet(snes,SNESLineSearchQuadratic_VI,PETSC_NULL);CHKERRQ(ierr); 21092b4ed282SShri Abhyankar break; 21102b4ed282SShri Abhyankar case 3: 21112b4ed282SShri Abhyankar ierr = SNESLineSearchSet(snes,SNESLineSearchCubic_VI,PETSC_NULL);CHKERRQ(ierr); 21122b4ed282SShri Abhyankar break; 21132b4ed282SShri Abhyankar } 2114fe835674SShri Abhyankar } 21152b4ed282SShri Abhyankar ierr = PetscOptionsTail();CHKERRQ(ierr); 21162b4ed282SShri Abhyankar PetscFunctionReturn(0); 21172b4ed282SShri Abhyankar } 21182b4ed282SShri Abhyankar /* -------------------------------------------------------------------------- */ 21192b4ed282SShri Abhyankar /*MC 21202b4ed282SShri Abhyankar SNESVI - Semismooth newton method based nonlinear solver that uses a line search 21212b4ed282SShri Abhyankar 21222b4ed282SShri Abhyankar Options Database: 2123be6adb11SBarry Smith + -snes_ls [cubic,quadratic,basic,basicnonorms] - Selects line search 2124be6adb11SBarry Smith . -snes_ls_alpha <alpha> - Sets alpha 2125be6adb11SBarry Smith . -snes_ls_maxstep <maxstep> - Sets the maximum stepsize the line search will use (if the 2-norm(y) > maxstep then scale y to be y = (maxstep/2-norm(y)) *y) 2126be6adb11SBarry Smith . -snes_ls_minlambda <minlambda> - Sets the minimum lambda the line search will use minlambda / max_i ( y[i]/x[i] ) 2127be6adb11SBarry Smith - -snes_ls_monitor - print information about progress of line searches 21282b4ed282SShri Abhyankar 21292b4ed282SShri Abhyankar 21302b4ed282SShri Abhyankar Level: beginner 21312b4ed282SShri Abhyankar 21322b4ed282SShri Abhyankar .seealso: SNESCreate(), SNES, SNESSetType(), SNESTR, SNESLineSearchSet(), 21332b4ed282SShri Abhyankar SNESLineSearchSetPostCheck(), SNESLineSearchNo(), SNESLineSearchCubic(), SNESLineSearchQuadratic(), 21342b4ed282SShri Abhyankar SNESLineSearchSet(), SNESLineSearchNoNorms(), SNESLineSearchSetPreCheck(), SNESLineSearchSetParams(), SNESLineSearchGetParams() 21352b4ed282SShri Abhyankar 21362b4ed282SShri Abhyankar M*/ 21372b4ed282SShri Abhyankar EXTERN_C_BEGIN 21382b4ed282SShri Abhyankar #undef __FUNCT__ 21392b4ed282SShri Abhyankar #define __FUNCT__ "SNESCreate_VI" 21407087cfbeSBarry Smith PetscErrorCode SNESCreate_VI(SNES snes) 21412b4ed282SShri Abhyankar { 21422b4ed282SShri Abhyankar PetscErrorCode ierr; 21432b4ed282SShri Abhyankar SNES_VI *vi; 21442b4ed282SShri Abhyankar 21452b4ed282SShri Abhyankar PetscFunctionBegin; 21462b4ed282SShri Abhyankar snes->ops->setup = SNESSetUp_VI; 214769c03620SShri Abhyankar snes->ops->solve = SNESSolveVI_SS; 21482b4ed282SShri Abhyankar snes->ops->destroy = SNESDestroy_VI; 21492b4ed282SShri Abhyankar snes->ops->setfromoptions = SNESSetFromOptions_VI; 21502b4ed282SShri Abhyankar snes->ops->view = SNESView_VI; 215137596af1SLisandro Dalcin snes->ops->reset = 0; /* XXX Implement!!! */ 21522b4ed282SShri Abhyankar snes->ops->converged = SNESDefaultConverged_VI; 21532b4ed282SShri Abhyankar 21542b4ed282SShri Abhyankar ierr = PetscNewLog(snes,SNES_VI,&vi);CHKERRQ(ierr); 21552b4ed282SShri Abhyankar snes->data = (void*)vi; 21562b4ed282SShri Abhyankar vi->alpha = 1.e-4; 21572b4ed282SShri Abhyankar vi->maxstep = 1.e8; 21582b4ed282SShri Abhyankar vi->minlambda = 1.e-12; 21597fe79bc4SShri Abhyankar vi->LineSearch = SNESLineSearchNo_VI; 21602b4ed282SShri Abhyankar vi->lsP = PETSC_NULL; 21612b4ed282SShri Abhyankar vi->postcheckstep = PETSC_NULL; 21622b4ed282SShri Abhyankar vi->postcheck = PETSC_NULL; 21632b4ed282SShri Abhyankar vi->precheckstep = PETSC_NULL; 21642b4ed282SShri Abhyankar vi->precheck = PETSC_NULL; 21652b4ed282SShri Abhyankar vi->const_tol = 2.2204460492503131e-16; 21662f63a38cSShri Abhyankar vi->checkredundancy = PETSC_NULL; 21672b4ed282SShri Abhyankar 21682b4ed282SShri Abhyankar ierr = PetscObjectComposeFunctionDynamic((PetscObject)snes,"SNESLineSearchSetMonitor_C","SNESLineSearchSetMonitor_VI",SNESLineSearchSetMonitor_VI);CHKERRQ(ierr); 21692b4ed282SShri Abhyankar ierr = PetscObjectComposeFunctionDynamic((PetscObject)snes,"SNESLineSearchSet_C","SNESLineSearchSet_VI",SNESLineSearchSet_VI);CHKERRQ(ierr); 21702b4ed282SShri Abhyankar 21712b4ed282SShri Abhyankar PetscFunctionReturn(0); 21722b4ed282SShri Abhyankar } 21732b4ed282SShri Abhyankar EXTERN_C_END 2174