12b4ed282SShri Abhyankar #define PETSCSNES_DLL 22b4ed282SShri Abhyankar 32b4ed282SShri Abhyankar #include "../src/snes/impls/vi/viimpl.h" 4408da460SShri Abhyankar #include "../include/private/kspimpl.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); 369308c137SBarry Smith ierr = MPI_Allreduce(&rnorm,&fnorm,1,MPIU_REAL,MPI_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) { 409308c137SBarry 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); 782b4ed282SShri Abhyankar 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" 1242b4ed282SShri Abhyankar PetscErrorCode SNESDefaultConverged_VI(SNES snes,PetscInt it,PetscReal xnorm,PetscReal gradnorm,PetscReal merit,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 */ 1362b4ed282SShri Abhyankar snes->ttol = merit*snes->rtol; 1372b4ed282SShri Abhyankar } 1382b4ed282SShri Abhyankar if (merit != merit) { 1392b4ed282SShri Abhyankar ierr = PetscInfo(snes,"Failed to converged, function norm is NaN\n");CHKERRQ(ierr); 1402b4ed282SShri Abhyankar *reason = SNES_DIVERGED_FNORM_NAN; 1412b4ed282SShri Abhyankar } else if (merit < snes->abstol) { 1422b4ed282SShri Abhyankar ierr = PetscInfo2(snes,"Converged due to merit function %G < %G\n",merit,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) { 1502b4ed282SShri Abhyankar if (merit < snes->ttol) { 1512b4ed282SShri Abhyankar ierr = PetscInfo2(snes,"Converged due to merit function %G < %G (relative tolerance)\n",merit,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; 1792b4ed282SShri Abhyankar ierr = VecNormBegin(phi,NORM_2,phinorm); 1802b4ed282SShri Abhyankar ierr = VecNormEnd(phi,NORM_2,phinorm); 1812b4ed282SShri Abhyankar 1822b4ed282SShri Abhyankar *merit = 0.5*(*phinorm)*(*phinorm); 1832b4ed282SShri Abhyankar PetscFunctionReturn(0); 1842b4ed282SShri Abhyankar } 1852b4ed282SShri Abhyankar 1862b4ed282SShri Abhyankar /* 1872b4ed282SShri Abhyankar ComputeFischerFunction - Computes the semismooth fischer burmeister function for a mixed complementarity equation. 1882b4ed282SShri Abhyankar 1892b4ed282SShri Abhyankar Notes: 1902b4ed282SShri Abhyankar The Fischer-Burmeister function is defined as 1912b4ed282SShri Abhyankar ff(a,b) := sqrt(a*a + b*b) - a - b 1922b4ed282SShri Abhyankar and is used reformulate a complementarity equation as a semismooth equation. 1932b4ed282SShri Abhyankar */ 1942b4ed282SShri Abhyankar 1952b4ed282SShri Abhyankar #undef __FUNCT__ 1962b4ed282SShri Abhyankar #define __FUNCT__ "ComputeFischerFunction" 1972b4ed282SShri Abhyankar static PetscErrorCode ComputeFischerFunction(PetscScalar a, PetscScalar b, PetscScalar* ff) 1982b4ed282SShri Abhyankar { 1992b4ed282SShri Abhyankar PetscFunctionBegin; 200*4c21c6cdSBarry Smith *ff = a + b - sqrt(a*a + b*b); 2012b4ed282SShri Abhyankar PetscFunctionReturn(0); 2022b4ed282SShri Abhyankar } 2032b4ed282SShri Abhyankar 204*4c21c6cdSBarry Smith static inline PetscScalar Phi(PetscScalar a,PetscScalar b) 205*4c21c6cdSBarry Smith { 206*4c21c6cdSBarry Smith return a + b - sqrt(a*a + b*b); 207*4c21c6cdSBarry Smith } 208*4c21c6cdSBarry Smith 209*4c21c6cdSBarry Smith static inline PetscScalar DPhi(PetscScalar a,PetscScalar b) 210*4c21c6cdSBarry Smith { 211*4c21c6cdSBarry Smith if ((PetscAbsScalar(a) >= 1.e-6) || (PetscAbsScalar(b) >= 1.e-6)) 212*4c21c6cdSBarry Smith return 1.0 - a/ sqrt(a*a + b*b); 213*4c21c6cdSBarry Smith else 214*4c21c6cdSBarry Smith return .5; 215*4c21c6cdSBarry Smith } 216*4c21c6cdSBarry Smith 2172b4ed282SShri Abhyankar /* 2181f79c099SShri Abhyankar SNESVIComputeFunction - Reformulates a system of nonlinear equations in mixed complementarity form to a system of nonlinear equations in semismooth form. 2192b4ed282SShri Abhyankar 2202b4ed282SShri Abhyankar Input Parameters: 2212b4ed282SShri Abhyankar . snes - the SNES context 2222b4ed282SShri Abhyankar . x - current iterate 2232b4ed282SShri Abhyankar . functx - user defined function context 2242b4ed282SShri Abhyankar 2252b4ed282SShri Abhyankar Output Parameters: 2262b4ed282SShri Abhyankar . phi - Semismooth function 2272b4ed282SShri Abhyankar 2282b4ed282SShri Abhyankar Notes: 2292b4ed282SShri Abhyankar The result of this function is done by cases: 2302b4ed282SShri Abhyankar + l[i] == -infinity, u[i] == infinity -- phi[i] = -f[i] 2312b4ed282SShri Abhyankar . l[i] == -infinity, u[i] finite -- phi[i] = ss(u[i]-x[i], -f[i]) 2322b4ed282SShri Abhyankar . l[i] finite, u[i] == infinity -- phi[i] = ss(x[i]-l[i], f[i]) 2332b4ed282SShri Abhyankar . l[i] finite < u[i] finite -- phi[i] = phi(x[i]-l[i], ss(u[i]-x[i], -f[u])) 2342b4ed282SShri Abhyankar - otherwise l[i] == u[i] -- phi[i] = l[i] - x[i] 2352b4ed282SShri Abhyankar ss is the semismoothing function used to reformulate the nonlinear equation in complementarity 2362b4ed282SShri Abhyankar form to semismooth form 2372b4ed282SShri Abhyankar 2382b4ed282SShri Abhyankar */ 2392b4ed282SShri Abhyankar #undef __FUNCT__ 2401f79c099SShri Abhyankar #define __FUNCT__ "SNESVIComputeFunction" 2411f79c099SShri Abhyankar static PetscErrorCode SNESVIComputeFunction(SNES snes,Vec X,Vec phi,void* functx) 2422b4ed282SShri Abhyankar { 2432b4ed282SShri Abhyankar PetscErrorCode ierr; 2442b4ed282SShri Abhyankar SNES_VI *vi = (SNES_VI*)snes->data; 2452b4ed282SShri Abhyankar Vec Xl = vi->xl,Xu = vi->xu,F = snes->vec_func; 246*4c21c6cdSBarry Smith PetscScalar *phi_arr,*x_arr,*f_arr,*l,*u; 2472b4ed282SShri Abhyankar PetscInt i,nlocal; 2482b4ed282SShri Abhyankar 2492b4ed282SShri Abhyankar PetscFunctionBegin; 2502b4ed282SShri Abhyankar ierr = (*vi->computeuserfunction)(snes,X,F,functx);CHKERRQ(ierr); 2512b4ed282SShri Abhyankar ierr = VecGetLocalSize(X,&nlocal);CHKERRQ(ierr); 2522b4ed282SShri Abhyankar 2532b4ed282SShri Abhyankar ierr = VecGetArray(X,&x_arr);CHKERRQ(ierr); 2542b4ed282SShri Abhyankar ierr = VecGetArray(F,&f_arr);CHKERRQ(ierr); 2552b4ed282SShri Abhyankar ierr = VecGetArray(Xl,&l);CHKERRQ(ierr); 2562b4ed282SShri Abhyankar ierr = VecGetArray(Xu,&u);CHKERRQ(ierr); 2572b4ed282SShri Abhyankar ierr = VecGetArray(phi,&phi_arr);CHKERRQ(ierr); 2582b4ed282SShri Abhyankar 2592b4ed282SShri Abhyankar for (i=0;i < nlocal;i++) { 2602b4ed282SShri Abhyankar if ((l[i] <= PETSC_VI_NINF) && (u[i] >= PETSC_VI_INF)) { 261*4c21c6cdSBarry Smith phi_arr[i] = f_arr[i]; 2622b4ed282SShri Abhyankar } 2632b4ed282SShri Abhyankar else if (l[i] <= PETSC_VI_NINF) { 264*4c21c6cdSBarry Smith phi_arr[i] = -Phi(u[i] - x_arr[i],-f_arr[i]); 2652b4ed282SShri Abhyankar } 2662b4ed282SShri Abhyankar else if (u[i] >= PETSC_VI_INF) { 267*4c21c6cdSBarry Smith phi_arr[i] = Phi(x_arr[i] - l[i],f_arr[i]); 2682b4ed282SShri Abhyankar } 2692b4ed282SShri Abhyankar else if (l[i] == u[i]) { 2702b4ed282SShri Abhyankar phi_arr[i] = l[i] - x_arr[i]; 2712b4ed282SShri Abhyankar } 2722b4ed282SShri Abhyankar else { 273*4c21c6cdSBarry Smith phi_arr[i] = Phi(x_arr[i] - l[i],-Phi(u[i] - x_arr[i],-f_arr[i])); 2742b4ed282SShri Abhyankar } 2752b4ed282SShri Abhyankar } 2762b4ed282SShri Abhyankar 2772b4ed282SShri Abhyankar ierr = VecRestoreArray(X,&x_arr);CHKERRQ(ierr); 2782b4ed282SShri Abhyankar ierr = VecRestoreArray(F,&f_arr);CHKERRQ(ierr); 2792b4ed282SShri Abhyankar ierr = VecRestoreArray(Xl,&l);CHKERRQ(ierr); 2802b4ed282SShri Abhyankar ierr = VecRestoreArray(Xu,&u);CHKERRQ(ierr); 2812b4ed282SShri Abhyankar ierr = VecRestoreArray(phi,&phi_arr);CHKERRQ(ierr); 2822b4ed282SShri Abhyankar 2832b4ed282SShri Abhyankar PetscFunctionReturn(0); 2842b4ed282SShri Abhyankar } 2852b4ed282SShri Abhyankar 286*4c21c6cdSBarry Smith 287*4c21c6cdSBarry Smith 2882b4ed282SShri Abhyankar /* 289a79edbefSShri Abhyankar SNESVIComputeBsubdifferentialVectors - Computes the diagonal shift (Da) and row scaling (Db) vectors needed for the 290a79edbefSShri Abhyankar the semismooth jacobian. 2912b4ed282SShri Abhyankar */ 2922b4ed282SShri Abhyankar #undef __FUNCT__ 293a79edbefSShri Abhyankar #define __FUNCT__ "SNESVIComputeBsubdifferentialVectors" 294a79edbefSShri Abhyankar PetscErrorCode SNESVIComputeBsubdifferentialVectors(SNES snes,Vec X,Vec F,Mat jac,Vec Da,Vec Db) 2952b4ed282SShri Abhyankar { 2962b4ed282SShri Abhyankar PetscErrorCode ierr; 2972b4ed282SShri Abhyankar SNES_VI *vi = (SNES_VI*)snes->data; 298*4c21c6cdSBarry Smith PetscScalar *l,*u,*x,*f,*da,*db,da1,da2,db1,db2; 2992b4ed282SShri Abhyankar PetscInt i,nlocal; 3002b4ed282SShri Abhyankar 3012b4ed282SShri Abhyankar PetscFunctionBegin; 3022b4ed282SShri Abhyankar 3032b4ed282SShri Abhyankar ierr = VecGetArray(X,&x);CHKERRQ(ierr); 3042b4ed282SShri Abhyankar ierr = VecGetArray(F,&f);CHKERRQ(ierr); 3052b4ed282SShri Abhyankar ierr = VecGetArray(vi->xl,&l);CHKERRQ(ierr); 3062b4ed282SShri Abhyankar ierr = VecGetArray(vi->xu,&u);CHKERRQ(ierr); 307a79edbefSShri Abhyankar ierr = VecGetArray(Da,&da);CHKERRQ(ierr); 308a79edbefSShri Abhyankar ierr = VecGetArray(Db,&db);CHKERRQ(ierr); 3092b4ed282SShri Abhyankar 3102b4ed282SShri Abhyankar ierr = VecGetLocalSize(X,&nlocal);CHKERRQ(ierr); 311*4c21c6cdSBarry Smith 3122b4ed282SShri Abhyankar for (i=0;i< nlocal;i++) { 313*4c21c6cdSBarry Smith if ((l[i] <= PETSC_VI_NINF) && (u[i] >= PETSC_VI_INF)) {/* Free variables */ 314*4c21c6cdSBarry Smith da[i] = 0; 3152b4ed282SShri Abhyankar db[i] = 1; 316*4c21c6cdSBarry Smith } else if (u[i] >= PETSC_VI_INF) { /* lower bounded variables */ 317*4c21c6cdSBarry Smith da[i] = DPhi(x[i] - l[i], f[i]); 318*4c21c6cdSBarry Smith db[i] = DPhi(f[i],x[i] - l[i]); 319*4c21c6cdSBarry Smith } else if (l[i] <= PETSC_VI_NINF) { /* upper bounded variables */ 320*4c21c6cdSBarry Smith da[i] = DPhi(u[i] - x[i], -f[i]); 321*4c21c6cdSBarry Smith db[i] = DPhi(-f[i],u[i] - x[i]); 322*4c21c6cdSBarry Smith } else if (l[i] == u[i]) { /* Fixed variables */ 323*4c21c6cdSBarry Smith da[i] = 1; 3242b4ed282SShri Abhyankar db[i] = 0; 325*4c21c6cdSBarry Smith } else { /* Box constrained variables */ 326*4c21c6cdSBarry Smith da1 = DPhi(x[i] - l[i], -Phi(u[i] - x[i], -f[i])); 327*4c21c6cdSBarry Smith db1 = DPhi(-Phi(u[i] - x[i], -f[i]),x[i] - l[i]); 328*4c21c6cdSBarry Smith da2 = DPhi(u[i] - x[i], -f[i]); 329*4c21c6cdSBarry Smith db2 = DPhi(-f[i],u[i] - x[i]); 330*4c21c6cdSBarry Smith da[i] = da1 + db1*da2; 331*4c21c6cdSBarry Smith db[i] = db1*db2; 3322b4ed282SShri Abhyankar } 3332b4ed282SShri Abhyankar } 3342b4ed282SShri Abhyankar ierr = VecRestoreArray(X,&x);CHKERRQ(ierr); 3352b4ed282SShri Abhyankar ierr = VecRestoreArray(F,&f);CHKERRQ(ierr); 3362b4ed282SShri Abhyankar ierr = VecRestoreArray(vi->xl,&l);CHKERRQ(ierr); 3372b4ed282SShri Abhyankar ierr = VecRestoreArray(vi->xu,&u);CHKERRQ(ierr); 338a79edbefSShri Abhyankar ierr = VecRestoreArray(Da,&da);CHKERRQ(ierr); 339a79edbefSShri Abhyankar ierr = VecRestoreArray(Db,&db);CHKERRQ(ierr); 3402b4ed282SShri Abhyankar 341a79edbefSShri Abhyankar PetscFunctionReturn(0); 342a79edbefSShri Abhyankar } 343a79edbefSShri Abhyankar 344a79edbefSShri Abhyankar /* 345a79edbefSShri 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. 346a79edbefSShri Abhyankar 347a79edbefSShri Abhyankar Input Parameters: 348a79edbefSShri Abhyankar . Da - Diagonal shift vector for the semismooth jacobian. 349a79edbefSShri Abhyankar . Db - Row scaling vector for the semismooth jacobian. 350a79edbefSShri Abhyankar 351a79edbefSShri Abhyankar Output Parameters: 352a79edbefSShri Abhyankar . jac - semismooth jacobian 353a79edbefSShri Abhyankar . jac_pre - optional preconditioning matrix 354a79edbefSShri Abhyankar 355a79edbefSShri Abhyankar Notes: 356a79edbefSShri Abhyankar The semismooth jacobian matrix is given by 357a79edbefSShri Abhyankar jac = Da + Db*jacfun 358a79edbefSShri Abhyankar where Db is the row scaling matrix stored as a vector, 359a79edbefSShri Abhyankar Da is the diagonal perturbation matrix stored as a vector 360a79edbefSShri Abhyankar and jacfun is the jacobian of the original nonlinear function. 361a79edbefSShri Abhyankar */ 362a79edbefSShri Abhyankar #undef __FUNCT__ 363a79edbefSShri Abhyankar #define __FUNCT__ "SNESVIComputeJacobian" 364a79edbefSShri Abhyankar PetscErrorCode SNESVIComputeJacobian(Mat jac, Mat jac_pre,Vec Da, Vec Db) 365a79edbefSShri Abhyankar { 366a79edbefSShri Abhyankar PetscErrorCode ierr; 367a79edbefSShri Abhyankar 3682b4ed282SShri Abhyankar /* Do row scaling and add diagonal perturbation */ 369a79edbefSShri Abhyankar ierr = MatDiagonalScale(jac,Db,PETSC_NULL);CHKERRQ(ierr); 370a79edbefSShri Abhyankar ierr = MatDiagonalSet(jac,Da,ADD_VALUES);CHKERRQ(ierr); 371a79edbefSShri Abhyankar if (jac != jac_pre) { /* If jac and jac_pre are different */ 372a79edbefSShri Abhyankar ierr = MatDiagonalScale(jac_pre,Db,PETSC_NULL); 373a79edbefSShri Abhyankar ierr = MatDiagonalSet(jac_pre,Da,ADD_VALUES);CHKERRQ(ierr); 3742b4ed282SShri Abhyankar } 3752b4ed282SShri Abhyankar PetscFunctionReturn(0); 3762b4ed282SShri Abhyankar } 3772b4ed282SShri Abhyankar 3782b4ed282SShri Abhyankar /* 379ee657d29SShri Abhyankar SNESVIComputeMeritFunctionGradient - Computes the gradient of the merit function psi. 380ee657d29SShri Abhyankar 381ee657d29SShri Abhyankar Input Parameters: 382ee657d29SShri Abhyankar phi - semismooth function. 383ee657d29SShri Abhyankar H - semismooth jacobian 384ee657d29SShri Abhyankar 385ee657d29SShri Abhyankar Output Parameters: 386ee657d29SShri Abhyankar dpsi - merit function gradient 387ee657d29SShri Abhyankar 388ee657d29SShri Abhyankar Notes: 389ee657d29SShri Abhyankar The merit function gradient is computed as follows 390ee657d29SShri Abhyankar dpsi = H^T*phi 391ee657d29SShri Abhyankar */ 392ee657d29SShri Abhyankar #undef __FUNCT__ 393ee657d29SShri Abhyankar #define __FUNCT__ "SNESVIComputeMeritFunctionGradient" 394ee657d29SShri Abhyankar PetscErrorCode SNESVIComputeMeritFunctionGradient(Mat H, Vec phi, Vec dpsi) 395ee657d29SShri Abhyankar { 396ee657d29SShri Abhyankar PetscErrorCode ierr; 397ee657d29SShri Abhyankar 398ee657d29SShri Abhyankar PetscFunctionBegin; 399ee657d29SShri Abhyankar ierr = MatMultTranspose(H,phi,dpsi); 400ee657d29SShri Abhyankar PetscFunctionReturn(0); 401ee657d29SShri Abhyankar } 402ee657d29SShri Abhyankar 403c1a5e521SShri Abhyankar /* -------------------------------------------------------------------------- */ 404c1a5e521SShri Abhyankar /* 405c1a5e521SShri Abhyankar SNESVIProjectOntoBounds - Projects X onto the feasible region so that Xl[i] <= X[i] <= Xu[i] for i = 1...n. 406c1a5e521SShri Abhyankar 407c1a5e521SShri Abhyankar Input Parameters: 408c1a5e521SShri Abhyankar . SNES - nonlinear solver context 409c1a5e521SShri Abhyankar 410c1a5e521SShri Abhyankar Output Parameters: 411c1a5e521SShri Abhyankar . X - Bound projected X 412c1a5e521SShri Abhyankar 413c1a5e521SShri Abhyankar */ 414c1a5e521SShri Abhyankar 415c1a5e521SShri Abhyankar #undef __FUNCT__ 416c1a5e521SShri Abhyankar #define __FUNCT__ "SNESVIProjectOntoBounds" 417c1a5e521SShri Abhyankar PetscErrorCode SNESVIProjectOntoBounds(SNES snes,Vec X) 418c1a5e521SShri Abhyankar { 419c1a5e521SShri Abhyankar PetscErrorCode ierr; 420c1a5e521SShri Abhyankar SNES_VI *vi = (SNES_VI*)snes->data; 421c1a5e521SShri Abhyankar const PetscScalar *xl,*xu; 422c1a5e521SShri Abhyankar PetscScalar *x; 423c1a5e521SShri Abhyankar PetscInt i,n; 424c1a5e521SShri Abhyankar 425c1a5e521SShri Abhyankar PetscFunctionBegin; 426c1a5e521SShri Abhyankar 427c1a5e521SShri Abhyankar ierr = VecGetLocalSize(X,&n);CHKERRQ(ierr); 428c1a5e521SShri Abhyankar ierr = VecGetArray(X,&x);CHKERRQ(ierr); 429c1a5e521SShri Abhyankar ierr = VecGetArrayRead(vi->xl,&xl);CHKERRQ(ierr); 430c1a5e521SShri Abhyankar ierr = VecGetArrayRead(vi->xu,&xu);CHKERRQ(ierr); 431c1a5e521SShri Abhyankar 432c1a5e521SShri Abhyankar for(i = 0;i<n;i++) { 433c1a5e521SShri Abhyankar if (x[i] < xl[i]) x[i] = xl[i]; 434c1a5e521SShri Abhyankar else if (x[i] > xu[i]) x[i] = xu[i]; 435c1a5e521SShri Abhyankar } 436c1a5e521SShri Abhyankar ierr = VecRestoreArray(X,&x);CHKERRQ(ierr); 437c1a5e521SShri Abhyankar ierr = VecRestoreArrayRead(vi->xl,&xl);CHKERRQ(ierr); 438c1a5e521SShri Abhyankar ierr = VecRestoreArrayRead(vi->xu,&xu);CHKERRQ(ierr); 439c1a5e521SShri Abhyankar 440c1a5e521SShri Abhyankar PetscFunctionReturn(0); 441c1a5e521SShri Abhyankar } 442c1a5e521SShri Abhyankar 443c1a5e521SShri Abhyankar 444ee657d29SShri Abhyankar /* 4452b4ed282SShri Abhyankar SNESVIAdjustInitialGuess - Readjusts the initial guess to the SNES solver supplied by the user so that the initial guess lies inside the feasible region . 4462b4ed282SShri Abhyankar 4472b4ed282SShri Abhyankar Input Parameters: 4482b4ed282SShri Abhyankar . lb - lower bound. 4492b4ed282SShri Abhyankar . ub - upper bound. 4502b4ed282SShri Abhyankar 4512b4ed282SShri Abhyankar Output Parameters: 4522b4ed282SShri Abhyankar . X - the readjusted initial guess. 4532b4ed282SShri Abhyankar 4542b4ed282SShri Abhyankar Notes: 4552b4ed282SShri Abhyankar The readjusted initial guess X[i] = max(max(min(l[i],X[i]),min(X[i],u[i])),min(l[i],u[i])) 4562b4ed282SShri Abhyankar */ 4572b4ed282SShri Abhyankar #undef __FUNCT__ 4582b4ed282SShri Abhyankar #define __FUNCT__ "SNESVIAdjustInitialGuess" 4592b4ed282SShri Abhyankar PetscErrorCode SNESVIAdjustInitialGuess(Vec X, Vec lb, Vec ub) 4602b4ed282SShri Abhyankar { 4612b4ed282SShri Abhyankar PetscErrorCode ierr; 4622b4ed282SShri Abhyankar PetscInt i,nlocal; 4632b4ed282SShri Abhyankar PetscScalar *x,*l,*u; 4642b4ed282SShri Abhyankar 4652b4ed282SShri Abhyankar PetscFunctionBegin; 4662b4ed282SShri Abhyankar 4672b4ed282SShri Abhyankar ierr = VecGetLocalSize(X,&nlocal);CHKERRQ(ierr); 4682b4ed282SShri Abhyankar ierr = VecGetArray(X,&x);CHKERRQ(ierr); 4692b4ed282SShri Abhyankar ierr = VecGetArray(lb,&l);CHKERRQ(ierr); 4702b4ed282SShri Abhyankar ierr = VecGetArray(ub,&u);CHKERRQ(ierr); 4712b4ed282SShri Abhyankar 4722b4ed282SShri Abhyankar for(i = 0; i < nlocal; i++) { 4732b4ed282SShri Abhyankar x[i] = PetscMax(PetscMax(PetscMin(x[i],l[i]),PetscMin(x[i],u[i])),PetscMin(l[i],u[i])); 4742b4ed282SShri Abhyankar } 4752b4ed282SShri Abhyankar 4762b4ed282SShri Abhyankar ierr = VecRestoreArray(X,&x);CHKERRQ(ierr); 4772b4ed282SShri Abhyankar ierr = VecRestoreArray(lb,&l);CHKERRQ(ierr); 4782b4ed282SShri Abhyankar ierr = VecRestoreArray(ub,&u);CHKERRQ(ierr); 4792b4ed282SShri Abhyankar 4802b4ed282SShri Abhyankar PetscFunctionReturn(0); 4812b4ed282SShri Abhyankar } 4822b4ed282SShri Abhyankar 4832b4ed282SShri Abhyankar /* -------------------------------------------------------------------- 4842b4ed282SShri Abhyankar 4852b4ed282SShri Abhyankar This file implements a semismooth truncated Newton method with a line search, 4862b4ed282SShri Abhyankar for solving a system of nonlinear equations in complementarity form, using the KSP, Vec, 4872b4ed282SShri Abhyankar and Mat interfaces for linear solvers, vectors, and matrices, 4882b4ed282SShri Abhyankar respectively. 4892b4ed282SShri Abhyankar 4902b4ed282SShri Abhyankar The following basic routines are required for each nonlinear solver: 4912b4ed282SShri Abhyankar SNESCreate_XXX() - Creates a nonlinear solver context 4922b4ed282SShri Abhyankar SNESSetFromOptions_XXX() - Sets runtime options 4932b4ed282SShri Abhyankar SNESSolve_XXX() - Solves the nonlinear system 4942b4ed282SShri Abhyankar SNESDestroy_XXX() - Destroys the nonlinear solver context 4952b4ed282SShri Abhyankar The suffix "_XXX" denotes a particular implementation, in this case 4962b4ed282SShri Abhyankar we use _VI (e.g., SNESCreate_VI, SNESSolve_VI) for solving 4972b4ed282SShri Abhyankar systems of nonlinear equations with a line search (LS) method. 4982b4ed282SShri Abhyankar These routines are actually called via the common user interface 4992b4ed282SShri Abhyankar routines SNESCreate(), SNESSetFromOptions(), SNESSolve(), and 5002b4ed282SShri Abhyankar SNESDestroy(), so the application code interface remains identical 5012b4ed282SShri Abhyankar for all nonlinear solvers. 5022b4ed282SShri Abhyankar 5032b4ed282SShri Abhyankar Another key routine is: 5042b4ed282SShri Abhyankar SNESSetUp_XXX() - Prepares for the use of a nonlinear solver 5052b4ed282SShri Abhyankar by setting data structures and options. The interface routine SNESSetUp() 5062b4ed282SShri Abhyankar is not usually called directly by the user, but instead is called by 5072b4ed282SShri Abhyankar SNESSolve() if necessary. 5082b4ed282SShri Abhyankar 5092b4ed282SShri Abhyankar Additional basic routines are: 5102b4ed282SShri Abhyankar SNESView_XXX() - Prints details of runtime options that 5112b4ed282SShri Abhyankar have actually been used. 5122b4ed282SShri Abhyankar These are called by application codes via the interface routines 5132b4ed282SShri Abhyankar SNESView(). 5142b4ed282SShri Abhyankar 5152b4ed282SShri Abhyankar The various types of solvers (preconditioners, Krylov subspace methods, 5162b4ed282SShri Abhyankar nonlinear solvers, timesteppers) are all organized similarly, so the 5172b4ed282SShri Abhyankar above description applies to these categories also. 5182b4ed282SShri Abhyankar 5192b4ed282SShri Abhyankar -------------------------------------------------------------------- */ 5202b4ed282SShri Abhyankar /* 52169c03620SShri Abhyankar SNESSolveVI_SS - Solves the complementarity problem with a semismooth Newton 5222b4ed282SShri Abhyankar method using a line search. 5232b4ed282SShri Abhyankar 5242b4ed282SShri Abhyankar Input Parameters: 5252b4ed282SShri Abhyankar . snes - the SNES context 5262b4ed282SShri Abhyankar 5272b4ed282SShri Abhyankar Output Parameter: 5282b4ed282SShri Abhyankar . outits - number of iterations until termination 5292b4ed282SShri Abhyankar 5302b4ed282SShri Abhyankar Application Interface Routine: SNESSolve() 5312b4ed282SShri Abhyankar 5322b4ed282SShri Abhyankar Notes: 5332b4ed282SShri Abhyankar This implements essentially a semismooth Newton method with a 5342b4ed282SShri Abhyankar line search. By default a cubic backtracking line search 5352b4ed282SShri Abhyankar is employed, as described in the text "Numerical Methods for 5362b4ed282SShri Abhyankar Unconstrained Optimization and Nonlinear Equations" by Dennis 5372b4ed282SShri Abhyankar and Schnabel. 5382b4ed282SShri Abhyankar */ 5392b4ed282SShri Abhyankar #undef __FUNCT__ 54069c03620SShri Abhyankar #define __FUNCT__ "SNESSolveVI_SS" 54169c03620SShri Abhyankar PetscErrorCode SNESSolveVI_SS(SNES snes) 5422b4ed282SShri Abhyankar { 5432b4ed282SShri Abhyankar SNES_VI *vi = (SNES_VI*)snes->data; 5442b4ed282SShri Abhyankar PetscErrorCode ierr; 5452b4ed282SShri Abhyankar PetscInt maxits,i,lits; 5463b336b49SShri Abhyankar PetscBool lssucceed; 5472b4ed282SShri Abhyankar MatStructure flg = DIFFERENT_NONZERO_PATTERN; 5482b4ed282SShri Abhyankar PetscReal gnorm,xnorm=0,ynorm; 5492b4ed282SShri Abhyankar Vec Y,X,F,G,W; 5502b4ed282SShri Abhyankar KSPConvergedReason kspreason; 5512b4ed282SShri Abhyankar 5522b4ed282SShri Abhyankar PetscFunctionBegin; 5539ce7406fSBarry Smith vi->computeuserfunction = snes->ops->computefunction; 5549ce7406fSBarry Smith snes->ops->computefunction = SNESVIComputeFunction; 5559ce7406fSBarry Smith 5562b4ed282SShri Abhyankar snes->numFailures = 0; 5572b4ed282SShri Abhyankar snes->numLinearSolveFailures = 0; 5582b4ed282SShri Abhyankar snes->reason = SNES_CONVERGED_ITERATING; 5592b4ed282SShri Abhyankar 5602b4ed282SShri Abhyankar maxits = snes->max_its; /* maximum number of iterations */ 5612b4ed282SShri Abhyankar X = snes->vec_sol; /* solution vector */ 5622b4ed282SShri Abhyankar F = snes->vec_func; /* residual vector */ 5632b4ed282SShri Abhyankar Y = snes->work[0]; /* work vectors */ 5642b4ed282SShri Abhyankar G = snes->work[1]; 5652b4ed282SShri Abhyankar W = snes->work[2]; 5662b4ed282SShri Abhyankar 5672b4ed282SShri Abhyankar ierr = PetscObjectTakeAccess(snes);CHKERRQ(ierr); 5682b4ed282SShri Abhyankar snes->iter = 0; 5692b4ed282SShri Abhyankar snes->norm = 0.0; 5702b4ed282SShri Abhyankar ierr = PetscObjectGrantAccess(snes);CHKERRQ(ierr); 5712b4ed282SShri Abhyankar 5722b4ed282SShri Abhyankar ierr = SNESVIAdjustInitialGuess(X,vi->xl,vi->xu);CHKERRQ(ierr); 5732b4ed282SShri Abhyankar ierr = SNESComputeFunction(snes,X,vi->phi);CHKERRQ(ierr); 5742b4ed282SShri Abhyankar if (snes->domainerror) { 5752b4ed282SShri Abhyankar snes->reason = SNES_DIVERGED_FUNCTION_DOMAIN; 5769ce7406fSBarry Smith snes->ops->computefunction = vi->computeuserfunction; 5772b4ed282SShri Abhyankar PetscFunctionReturn(0); 5782b4ed282SShri Abhyankar } 5792b4ed282SShri Abhyankar /* Compute Merit function */ 5802b4ed282SShri Abhyankar ierr = SNESVIComputeMeritFunction(vi->phi,&vi->merit,&vi->phinorm);CHKERRQ(ierr); 5812b4ed282SShri Abhyankar 5822b4ed282SShri Abhyankar ierr = VecNormBegin(X,NORM_2,&xnorm);CHKERRQ(ierr); /* xnorm <- ||x|| */ 5832b4ed282SShri Abhyankar ierr = VecNormEnd(X,NORM_2,&xnorm);CHKERRQ(ierr); 5842b4ed282SShri Abhyankar if PetscIsInfOrNanReal(vi->merit) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FP,"User provided compute function generated a Not-a-Number"); 5852b4ed282SShri Abhyankar 5862b4ed282SShri Abhyankar ierr = PetscObjectTakeAccess(snes);CHKERRQ(ierr); 5872b4ed282SShri Abhyankar snes->norm = vi->phinorm; 5882b4ed282SShri Abhyankar ierr = PetscObjectGrantAccess(snes);CHKERRQ(ierr); 5892b4ed282SShri Abhyankar SNESLogConvHistory(snes,vi->phinorm,0); 5902b4ed282SShri Abhyankar SNESMonitor(snes,0,vi->phinorm); 5912b4ed282SShri Abhyankar 5922b4ed282SShri Abhyankar /* set parameter for default relative tolerance convergence test */ 5932b4ed282SShri Abhyankar snes->ttol = vi->phinorm*snes->rtol; 5942b4ed282SShri Abhyankar /* test convergence */ 5952b4ed282SShri Abhyankar ierr = (*snes->ops->converged)(snes,0,0.0,0.0,vi->phinorm,&snes->reason,snes->cnvP);CHKERRQ(ierr); 5969ce7406fSBarry Smith if (snes->reason) { 5979ce7406fSBarry Smith snes->ops->computefunction = vi->computeuserfunction; 5989ce7406fSBarry Smith PetscFunctionReturn(0); 5999ce7406fSBarry Smith } 6002b4ed282SShri Abhyankar 6012b4ed282SShri Abhyankar for (i=0; i<maxits; i++) { 6022b4ed282SShri Abhyankar 6032b4ed282SShri Abhyankar /* Call general purpose update function */ 6042b4ed282SShri Abhyankar if (snes->ops->update) { 6052b4ed282SShri Abhyankar ierr = (*snes->ops->update)(snes, snes->iter);CHKERRQ(ierr); 6062b4ed282SShri Abhyankar } 6072b4ed282SShri Abhyankar 6082b4ed282SShri Abhyankar /* Solve J Y = Phi, where J is the semismooth jacobian */ 609a79edbefSShri Abhyankar /* Get the nonlinear function jacobian */ 6102b4ed282SShri Abhyankar ierr = SNESComputeJacobian(snes,X,&snes->jacobian,&snes->jacobian_pre,&flg);CHKERRQ(ierr); 611a79edbefSShri Abhyankar /* Get the diagonal shift and row scaling vectors */ 612a79edbefSShri Abhyankar ierr = SNESVIComputeBsubdifferentialVectors(snes,X,F,snes->jacobian,vi->Da,vi->Db);CHKERRQ(ierr); 613a79edbefSShri Abhyankar /* Compute the semismooth jacobian */ 614a79edbefSShri Abhyankar ierr = SNESVIComputeJacobian(snes->jacobian,snes->jacobian_pre,vi->Da,vi->Db);CHKERRQ(ierr); 615ee657d29SShri Abhyankar /* Compute the merit function gradient */ 616ee657d29SShri Abhyankar ierr = SNESVIComputeMeritFunctionGradient(snes->jacobian,vi->phi,vi->dpsi);CHKERRQ(ierr); 6172b4ed282SShri Abhyankar ierr = KSPSetOperators(snes->ksp,snes->jacobian,snes->jacobian_pre,flg);CHKERRQ(ierr); 6182b4ed282SShri Abhyankar ierr = SNES_KSPSolve(snes,snes->ksp,vi->phi,Y);CHKERRQ(ierr); 6192b4ed282SShri Abhyankar ierr = KSPGetConvergedReason(snes->ksp,&kspreason);CHKERRQ(ierr); 6203b336b49SShri Abhyankar 6213b336b49SShri Abhyankar if (kspreason < 0) { 6222b4ed282SShri Abhyankar if (++snes->numLinearSolveFailures >= snes->maxLinearSolveFailures) { 6232b4ed282SShri 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); 6242b4ed282SShri Abhyankar snes->reason = SNES_DIVERGED_LINEAR_SOLVE; 6252b4ed282SShri Abhyankar break; 6262b4ed282SShri Abhyankar } 6272b4ed282SShri Abhyankar } 6282b4ed282SShri Abhyankar ierr = KSPGetIterationNumber(snes->ksp,&lits);CHKERRQ(ierr); 6292b4ed282SShri Abhyankar snes->linear_its += lits; 6302b4ed282SShri Abhyankar ierr = PetscInfo2(snes,"iter=%D, linear solve iterations=%D\n",snes->iter,lits);CHKERRQ(ierr); 6312b4ed282SShri Abhyankar /* 6322b4ed282SShri Abhyankar if (vi->precheckstep) { 633ace3abfcSBarry Smith PetscBool changed_y = PETSC_FALSE; 6342b4ed282SShri Abhyankar ierr = (*vi->precheckstep)(snes,X,Y,vi->precheck,&changed_y);CHKERRQ(ierr); 6352b4ed282SShri Abhyankar } 6362b4ed282SShri Abhyankar 6372b4ed282SShri Abhyankar if (PetscLogPrintInfo){ 6382b4ed282SShri Abhyankar ierr = SNESVICheckResidual_Private(snes,snes->jacobian,F,Y,G,W);CHKERRQ(ierr); 6392b4ed282SShri Abhyankar } 6402b4ed282SShri Abhyankar */ 6412b4ed282SShri Abhyankar /* Compute a (scaled) negative update in the line search routine: 6422b4ed282SShri Abhyankar Y <- X - lambda*Y 6432b4ed282SShri Abhyankar and evaluate G = function(Y) (depends on the line search). 6442b4ed282SShri Abhyankar */ 6452b4ed282SShri Abhyankar ierr = VecCopy(Y,snes->vec_sol_update);CHKERRQ(ierr); 6462b4ed282SShri Abhyankar ynorm = 1; gnorm = vi->phinorm; 6472b4ed282SShri Abhyankar ierr = (*vi->LineSearch)(snes,vi->lsP,X,vi->phi,G,Y,W,vi->phinorm,xnorm,&ynorm,&gnorm,&lssucceed);CHKERRQ(ierr); 6482b4ed282SShri Abhyankar ierr = PetscInfo4(snes,"fnorm=%18.16e, gnorm=%18.16e, ynorm=%18.16e, lssucceed=%d\n",vi->phinorm,gnorm,ynorm,(int)lssucceed);CHKERRQ(ierr); 6492b4ed282SShri Abhyankar if (snes->reason == SNES_DIVERGED_FUNCTION_COUNT) break; 6502b4ed282SShri Abhyankar if (snes->domainerror) { 6512b4ed282SShri Abhyankar snes->reason = SNES_DIVERGED_FUNCTION_DOMAIN; 6529ce7406fSBarry Smith snes->ops->computefunction = vi->computeuserfunction; 6532b4ed282SShri Abhyankar PetscFunctionReturn(0); 6542b4ed282SShri Abhyankar } 6552b4ed282SShri Abhyankar if (!lssucceed) { 6562b4ed282SShri Abhyankar if (++snes->numFailures >= snes->maxFailures) { 657ace3abfcSBarry Smith PetscBool ismin; 6582b4ed282SShri Abhyankar snes->reason = SNES_DIVERGED_LINE_SEARCH; 6592b4ed282SShri Abhyankar ierr = SNESVICheckLocalMin_Private(snes,snes->jacobian,G,W,gnorm,&ismin);CHKERRQ(ierr); 6602b4ed282SShri Abhyankar if (ismin) snes->reason = SNES_DIVERGED_LOCAL_MIN; 6612b4ed282SShri Abhyankar break; 6622b4ed282SShri Abhyankar } 6632b4ed282SShri Abhyankar } 6642b4ed282SShri Abhyankar /* Update function and solution vectors */ 6652b4ed282SShri Abhyankar vi->phinorm = gnorm; 6662b4ed282SShri Abhyankar vi->merit = 0.5*vi->phinorm*vi->phinorm; 6672b4ed282SShri Abhyankar ierr = VecCopy(G,vi->phi);CHKERRQ(ierr); 6682b4ed282SShri Abhyankar ierr = VecCopy(W,X);CHKERRQ(ierr); 6692b4ed282SShri Abhyankar /* Monitor convergence */ 6702b4ed282SShri Abhyankar ierr = PetscObjectTakeAccess(snes);CHKERRQ(ierr); 6712b4ed282SShri Abhyankar snes->iter = i+1; 6722b4ed282SShri Abhyankar snes->norm = vi->phinorm; 6732b4ed282SShri Abhyankar ierr = PetscObjectGrantAccess(snes);CHKERRQ(ierr); 6742b4ed282SShri Abhyankar SNESLogConvHistory(snes,snes->norm,lits); 6752b4ed282SShri Abhyankar SNESMonitor(snes,snes->iter,snes->norm); 6762b4ed282SShri Abhyankar /* Test for convergence, xnorm = || X || */ 6772b4ed282SShri Abhyankar if (snes->ops->converged != SNESSkipConverged) { ierr = VecNorm(X,NORM_2,&xnorm);CHKERRQ(ierr); } 6782b4ed282SShri Abhyankar ierr = (*snes->ops->converged)(snes,snes->iter,xnorm,ynorm,vi->phinorm,&snes->reason,snes->cnvP);CHKERRQ(ierr); 6792b4ed282SShri Abhyankar if (snes->reason) break; 6802b4ed282SShri Abhyankar } 6812b4ed282SShri Abhyankar if (i == maxits) { 6822b4ed282SShri Abhyankar ierr = PetscInfo1(snes,"Maximum number of iterations has been reached: %D\n",maxits);CHKERRQ(ierr); 6832b4ed282SShri Abhyankar if(!snes->reason) snes->reason = SNES_DIVERGED_MAX_IT; 6842b4ed282SShri Abhyankar } 6859ce7406fSBarry Smith snes->ops->computefunction = vi->computeuserfunction; 6862b4ed282SShri Abhyankar PetscFunctionReturn(0); 6872b4ed282SShri Abhyankar } 68869c03620SShri Abhyankar 68969c03620SShri Abhyankar #undef __FUNCT__ 69069c03620SShri Abhyankar #define __FUNCT__ "SNESVICreateIndexSets_AS" 691a79edbefSShri Abhyankar PetscErrorCode SNESVICreateIndexSets_AS(SNES snes,Vec Db,PetscReal thresh,IS* ISact,IS* ISinact) 69269c03620SShri Abhyankar { 69369c03620SShri Abhyankar PetscErrorCode ierr; 69469c03620SShri Abhyankar PetscInt i,nlocal,ilow,ihigh,nloc_isact=0,nloc_isinact=0; 69569c03620SShri Abhyankar PetscInt *idx_act,*idx_inact,i1=0,i2=0; 69669c03620SShri Abhyankar PetscScalar *db; 69769c03620SShri Abhyankar 69869c03620SShri Abhyankar PetscFunctionBegin; 69969c03620SShri Abhyankar 70069c03620SShri Abhyankar ierr = VecGetLocalSize(Db,&nlocal);CHKERRQ(ierr); 70169c03620SShri Abhyankar ierr = VecGetOwnershipRange(Db,&ilow,&ihigh);CHKERRQ(ierr); 70269c03620SShri Abhyankar ierr = VecGetArray(Db,&db);CHKERRQ(ierr); 70369c03620SShri Abhyankar /* Compute the sizes of the active and inactive sets */ 70469c03620SShri Abhyankar for (i=0; i < nlocal;i++) { 705fca35906SShri Abhyankar if (PetscAbsScalar(db[i]) <= thresh) nloc_isact++; 706fca35906SShri Abhyankar else nloc_isinact++; 70769c03620SShri Abhyankar } 70869c03620SShri Abhyankar ierr = PetscMalloc(nloc_isact*sizeof(PetscInt),&idx_act);CHKERRQ(ierr); 70969c03620SShri Abhyankar ierr = PetscMalloc(nloc_isinact*sizeof(PetscInt),&idx_inact);CHKERRQ(ierr); 71069c03620SShri Abhyankar 71169c03620SShri Abhyankar /* Creating the indexing arrays */ 712fca35906SShri Abhyankar for(i=0; i < nlocal; i++) { 713fca35906SShri Abhyankar if (PetscAbsScalar(db[i]) <= thresh) idx_act[i1++] = ilow+i; 714fca35906SShri Abhyankar else idx_inact[i2++] = ilow+i; 71569c03620SShri Abhyankar } 71669c03620SShri Abhyankar 71769c03620SShri Abhyankar /* Create the index sets */ 71869c03620SShri Abhyankar ierr = ISCreateGeneral(((PetscObject)snes)->comm,nloc_isact,idx_act,PETSC_COPY_VALUES,ISact);CHKERRQ(ierr); 71969c03620SShri Abhyankar ierr = ISCreateGeneral(((PetscObject)snes)->comm,nloc_isinact,idx_inact,PETSC_COPY_VALUES,ISinact);CHKERRQ(ierr); 72069c03620SShri Abhyankar 72169c03620SShri Abhyankar ierr = VecRestoreArray(Db,&db);CHKERRQ(ierr); 72269c03620SShri Abhyankar ierr = PetscFree(idx_act);CHKERRQ(ierr); 72369c03620SShri Abhyankar ierr = PetscFree(idx_inact);CHKERRQ(ierr); 72469c03620SShri Abhyankar PetscFunctionReturn(0); 72569c03620SShri Abhyankar } 72669c03620SShri Abhyankar 727d950fb63SShri Abhyankar #undef __FUNCT__ 728d950fb63SShri Abhyankar #define __FUNCT__ "SNESVICreateIndexSets_RS" 729d950fb63SShri Abhyankar PetscErrorCode SNESVICreateIndexSets_RS(SNES snes,Vec X,Vec Xl, Vec Xu,IS* ISact,IS* ISinact) 730d950fb63SShri Abhyankar { 731d950fb63SShri Abhyankar PetscErrorCode ierr; 732d950fb63SShri Abhyankar PetscInt i,nlocal,ilow,ihigh,nloc_isact=0,nloc_isinact=0; 733d950fb63SShri Abhyankar PetscInt *idx_act,*idx_inact,i1=0,i2=0; 734fe835674SShri Abhyankar const PetscScalar *x,*xl,*xu,*f; 735d950fb63SShri Abhyankar Vec F = snes->vec_func; 736d950fb63SShri Abhyankar 737d950fb63SShri Abhyankar PetscFunctionBegin; 738d950fb63SShri Abhyankar 739d950fb63SShri Abhyankar ierr = VecGetLocalSize(X,&nlocal);CHKERRQ(ierr); 740d950fb63SShri Abhyankar ierr = VecGetOwnershipRange(X,&ilow,&ihigh);CHKERRQ(ierr); 741fe835674SShri Abhyankar ierr = VecGetArrayRead(X,&x);CHKERRQ(ierr); 742fe835674SShri Abhyankar ierr = VecGetArrayRead(Xl,&xl);CHKERRQ(ierr); 743fe835674SShri Abhyankar ierr = VecGetArrayRead(Xu,&xu);CHKERRQ(ierr); 744fe835674SShri Abhyankar ierr = VecGetArrayRead(F,&f);CHKERRQ(ierr); 745d950fb63SShri Abhyankar /* Compute the sizes of the active and inactive sets */ 746d950fb63SShri Abhyankar for (i=0; i < nlocal;i++) { 747fe835674SShri 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_isinact++; 748fe835674SShri Abhyankar else nloc_isact++; 749d950fb63SShri Abhyankar } 750d950fb63SShri Abhyankar ierr = PetscMalloc(nloc_isact*sizeof(PetscInt),&idx_act);CHKERRQ(ierr); 751d950fb63SShri Abhyankar ierr = PetscMalloc(nloc_isinact*sizeof(PetscInt),&idx_inact);CHKERRQ(ierr); 752d950fb63SShri Abhyankar 753d950fb63SShri Abhyankar /* Creating the indexing arrays */ 754d950fb63SShri Abhyankar for(i=0; i < nlocal; i++) { 755fe835674SShri 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_inact[i2++] = ilow+i; 756fe835674SShri Abhyankar else idx_act[i1++] = ilow+i; 757d950fb63SShri Abhyankar } 758d950fb63SShri Abhyankar 759d950fb63SShri Abhyankar /* Create the index sets */ 760d950fb63SShri Abhyankar ierr = ISCreateGeneral(((PetscObject)snes)->comm,nloc_isact,idx_act,PETSC_COPY_VALUES,ISact);CHKERRQ(ierr); 761d950fb63SShri Abhyankar ierr = ISCreateGeneral(((PetscObject)snes)->comm,nloc_isinact,idx_inact,PETSC_COPY_VALUES,ISinact);CHKERRQ(ierr); 762d950fb63SShri Abhyankar 763fe835674SShri Abhyankar ierr = VecRestoreArrayRead(X,&x);CHKERRQ(ierr); 764fe835674SShri Abhyankar ierr = VecRestoreArrayRead(Xl,&xl);CHKERRQ(ierr); 765fe835674SShri Abhyankar ierr = VecRestoreArrayRead(Xu,&xu);CHKERRQ(ierr); 766fe835674SShri Abhyankar ierr = VecRestoreArrayRead(F,&f);CHKERRQ(ierr); 767d950fb63SShri Abhyankar ierr = PetscFree(idx_act);CHKERRQ(ierr); 768d950fb63SShri Abhyankar ierr = PetscFree(idx_inact);CHKERRQ(ierr); 769d950fb63SShri Abhyankar PetscFunctionReturn(0); 770d950fb63SShri Abhyankar } 771d950fb63SShri Abhyankar 772dbd914b8SShri Abhyankar /* Create active and inactive set vectors. The local size of this vector is set and petsc computes the global size */ 773dbd914b8SShri Abhyankar #undef __FUNCT__ 774fe835674SShri Abhyankar #define __FUNCT__ "SNESVICreateSubVectors" 775fe835674SShri Abhyankar PetscErrorCode SNESVICreateSubVectors(SNES snes,PetscInt n,Vec* newv) 776dbd914b8SShri Abhyankar { 777dbd914b8SShri Abhyankar PetscErrorCode ierr; 778dbd914b8SShri Abhyankar Vec v; 779dbd914b8SShri Abhyankar 780dbd914b8SShri Abhyankar PetscFunctionBegin; 781dbd914b8SShri Abhyankar ierr = VecCreate(((PetscObject)snes)->comm,&v);CHKERRQ(ierr); 782dbd914b8SShri Abhyankar ierr = VecSetSizes(v,n,PETSC_DECIDE);CHKERRQ(ierr); 783dbd914b8SShri Abhyankar ierr = VecSetFromOptions(v);CHKERRQ(ierr); 784dbd914b8SShri Abhyankar *newv = v; 785dbd914b8SShri Abhyankar 786dbd914b8SShri Abhyankar PetscFunctionReturn(0); 787dbd914b8SShri Abhyankar } 788dbd914b8SShri Abhyankar 789732bb160SShri Abhyankar /* Resets the snes PC and KSP when the active set sizes change */ 790732bb160SShri Abhyankar #undef __FUNCT__ 791732bb160SShri Abhyankar #define __FUNCT__ "SNESVIResetPCandKSP" 792732bb160SShri Abhyankar PetscErrorCode SNESVIResetPCandKSP(SNES snes,Mat Amat,Mat Pmat) 793732bb160SShri Abhyankar { 794732bb160SShri Abhyankar PetscErrorCode ierr; 795732bb160SShri Abhyankar KSP kspnew,snesksp; 796732bb160SShri Abhyankar PC pcnew; 797732bb160SShri Abhyankar const MatSolverPackage stype; 798dbd914b8SShri Abhyankar 799732bb160SShri Abhyankar PetscFunctionBegin; 800732bb160SShri Abhyankar /* The active and inactive set sizes have changed so need to create a new snes->ksp object */ 801732bb160SShri Abhyankar ierr = SNESGetKSP(snes,&snesksp);CHKERRQ(ierr); 802732bb160SShri Abhyankar ierr = KSPCreate(((PetscObject)snes)->comm,&kspnew);CHKERRQ(ierr); 803732bb160SShri Abhyankar /* Copy over snes->ksp info */ 804732bb160SShri Abhyankar kspnew->pc_side = snesksp->pc_side; 805732bb160SShri Abhyankar kspnew->rtol = snesksp->rtol; 806732bb160SShri Abhyankar kspnew->abstol = snesksp->abstol; 807732bb160SShri Abhyankar kspnew->max_it = snesksp->max_it; 808732bb160SShri Abhyankar ierr = KSPSetType(kspnew,((PetscObject)snesksp)->type_name);CHKERRQ(ierr); 809732bb160SShri Abhyankar ierr = KSPGetPC(kspnew,&pcnew);CHKERRQ(ierr); 810732bb160SShri Abhyankar ierr = PCSetType(kspnew->pc,((PetscObject)snesksp->pc)->type_name);CHKERRQ(ierr); 811732bb160SShri Abhyankar ierr = PCSetOperators(kspnew->pc,Amat,Pmat,DIFFERENT_NONZERO_PATTERN);CHKERRQ(ierr); 812732bb160SShri Abhyankar ierr = PCFactorGetMatSolverPackage(snesksp->pc,&stype);CHKERRQ(ierr); 813732bb160SShri Abhyankar ierr = PCFactorSetMatSolverPackage(kspnew->pc,stype);CHKERRQ(ierr); 814732bb160SShri Abhyankar ierr = KSPDestroy(snesksp);CHKERRQ(ierr); 815732bb160SShri Abhyankar snes->ksp = kspnew; 816732bb160SShri Abhyankar ierr = PetscLogObjectParent(snes,kspnew);CHKERRQ(ierr); 817732bb160SShri Abhyankar ierr = KSPSetFromOptions(kspnew);CHKERRQ(ierr); 818732bb160SShri Abhyankar PetscFunctionReturn(0); 819732bb160SShri Abhyankar } 82069c03620SShri Abhyankar /* Variational Inequality solver using active set method */ 82169c03620SShri Abhyankar #undef __FUNCT__ 82269c03620SShri Abhyankar #define __FUNCT__ "SNESSolveVI_AS" 82369c03620SShri Abhyankar PetscErrorCode SNESSolveVI_AS(SNES snes) 82469c03620SShri Abhyankar { 82569c03620SShri Abhyankar SNES_VI *vi = (SNES_VI*)snes->data; 82669c03620SShri Abhyankar PetscErrorCode ierr; 827408da460SShri Abhyankar PetscInt maxits,i,lits,Nis_act=0; 8283b336b49SShri Abhyankar PetscBool lssucceed; 82969c03620SShri Abhyankar MatStructure flg = DIFFERENT_NONZERO_PATTERN; 83069c03620SShri Abhyankar PetscReal gnorm,xnorm=0,ynorm; 83169c03620SShri Abhyankar Vec Y,X,F,G,W; 83269c03620SShri Abhyankar KSPConvergedReason kspreason; 83369c03620SShri Abhyankar 83469c03620SShri Abhyankar PetscFunctionBegin; 8359ce7406fSBarry Smith vi->computeuserfunction = snes->ops->computefunction; 8369ce7406fSBarry Smith snes->ops->computefunction = SNESVIComputeFunction; 83769c03620SShri Abhyankar snes->numFailures = 0; 83869c03620SShri Abhyankar snes->numLinearSolveFailures = 0; 83969c03620SShri Abhyankar snes->reason = SNES_CONVERGED_ITERATING; 84069c03620SShri Abhyankar 84169c03620SShri Abhyankar maxits = snes->max_its; /* maximum number of iterations */ 84269c03620SShri Abhyankar X = snes->vec_sol; /* solution vector */ 84369c03620SShri Abhyankar F = snes->vec_func; /* residual vector */ 84469c03620SShri Abhyankar Y = snes->work[0]; /* work vectors */ 84569c03620SShri Abhyankar G = snes->work[1]; 84669c03620SShri Abhyankar W = snes->work[2]; 84769c03620SShri Abhyankar 84869c03620SShri Abhyankar ierr = PetscObjectTakeAccess(snes);CHKERRQ(ierr); 84969c03620SShri Abhyankar snes->iter = 0; 85069c03620SShri Abhyankar snes->norm = 0.0; 85169c03620SShri Abhyankar ierr = PetscObjectGrantAccess(snes);CHKERRQ(ierr); 85269c03620SShri Abhyankar 85369c03620SShri Abhyankar ierr = SNESVIAdjustInitialGuess(X,vi->xl,vi->xu);CHKERRQ(ierr); 85469c03620SShri Abhyankar ierr = SNESComputeFunction(snes,X,vi->phi);CHKERRQ(ierr); 85569c03620SShri Abhyankar if (snes->domainerror) { 85669c03620SShri Abhyankar snes->reason = SNES_DIVERGED_FUNCTION_DOMAIN; 8579ce7406fSBarry Smith snes->ops->computefunction = vi->computeuserfunction; 85869c03620SShri Abhyankar PetscFunctionReturn(0); 85969c03620SShri Abhyankar } 86069c03620SShri Abhyankar /* Compute Merit function */ 86169c03620SShri Abhyankar ierr = SNESVIComputeMeritFunction(vi->phi,&vi->merit,&vi->phinorm);CHKERRQ(ierr); 86269c03620SShri Abhyankar 86369c03620SShri Abhyankar ierr = VecNormBegin(X,NORM_2,&xnorm);CHKERRQ(ierr); /* xnorm <- ||x|| */ 86469c03620SShri Abhyankar ierr = VecNormEnd(X,NORM_2,&xnorm);CHKERRQ(ierr); 86569c03620SShri Abhyankar if PetscIsInfOrNanReal(vi->merit) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FP,"User provided compute function generated a Not-a-Number"); 86669c03620SShri Abhyankar 86769c03620SShri Abhyankar ierr = PetscObjectTakeAccess(snes);CHKERRQ(ierr); 86869c03620SShri Abhyankar snes->norm = vi->phinorm; 86969c03620SShri Abhyankar ierr = PetscObjectGrantAccess(snes);CHKERRQ(ierr); 87069c03620SShri Abhyankar SNESLogConvHistory(snes,vi->phinorm,0); 87169c03620SShri Abhyankar SNESMonitor(snes,0,vi->phinorm); 87269c03620SShri Abhyankar 87369c03620SShri Abhyankar /* set parameter for default relative tolerance convergence test */ 87469c03620SShri Abhyankar snes->ttol = vi->phinorm*snes->rtol; 87569c03620SShri Abhyankar /* test convergence */ 87669c03620SShri Abhyankar ierr = (*snes->ops->converged)(snes,0,0.0,0.0,vi->phinorm,&snes->reason,snes->cnvP);CHKERRQ(ierr); 8779ce7406fSBarry Smith if (snes->reason) { 8789ce7406fSBarry Smith snes->ops->computefunction = vi->computeuserfunction; 8799ce7406fSBarry Smith PetscFunctionReturn(0); 8809ce7406fSBarry Smith } 88169c03620SShri Abhyankar 88269c03620SShri Abhyankar for (i=0; i<maxits; i++) { 88369c03620SShri Abhyankar 884a79edbefSShri Abhyankar IS IS_act,IS_inact; /* _act -> active set _inact -> inactive set */ 885a79edbefSShri Abhyankar PetscReal thresh,J_norm1; 886dbd914b8SShri Abhyankar VecScatter scat_act,scat_inact; 887408da460SShri Abhyankar PetscInt nis_act,nis_inact,Nis_act_prev; 888dbd914b8SShri Abhyankar Vec Da_act,Da_inact,Db_inact; 889dbd914b8SShri Abhyankar Vec Y_act,Y_inact,phi_act,phi_inact; 890d76c674bSShri Abhyankar Mat jac_inact_inact,jac_inact_act,prejac_inact_inact; 891a79edbefSShri Abhyankar 89269c03620SShri Abhyankar /* Call general purpose update function */ 89369c03620SShri Abhyankar if (snes->ops->update) { 89469c03620SShri Abhyankar ierr = (*snes->ops->update)(snes, snes->iter);CHKERRQ(ierr); 89569c03620SShri Abhyankar } 89669c03620SShri Abhyankar ierr = SNESComputeJacobian(snes,X,&snes->jacobian,&snes->jacobian_pre,&flg);CHKERRQ(ierr); 89769c03620SShri Abhyankar /* Compute the threshold value for creating active and inactive sets */ 89869c03620SShri Abhyankar ierr = MatNorm(snes->jacobian,NORM_1,&J_norm1);CHKERRQ(ierr); 89969c03620SShri Abhyankar thresh = PetscMin(vi->merit,1e-2)/(1+J_norm1); 900a79edbefSShri Abhyankar 901a79edbefSShri Abhyankar /* Compute B-subdifferential vectors Da and Db */ 902a79edbefSShri Abhyankar ierr = SNESVIComputeBsubdifferentialVectors(snes,X,F,snes->jacobian,vi->Da,vi->Db);CHKERRQ(ierr); 903dbd914b8SShri Abhyankar 90469c03620SShri Abhyankar /* Create active and inactive index sets */ 90569c03620SShri Abhyankar ierr = SNESVICreateIndexSets_AS(snes,vi->Db,thresh,&IS_act,&IS_inact);CHKERRQ(ierr); 90669c03620SShri Abhyankar 907408da460SShri Abhyankar Nis_act_prev = Nis_act; 908408da460SShri Abhyankar /* Get sizes of active and inactive sets */ 909dbd914b8SShri Abhyankar ierr = ISGetLocalSize(IS_act,&nis_act);CHKERRQ(ierr); 910dbd914b8SShri Abhyankar ierr = ISGetLocalSize(IS_inact,&nis_inact);CHKERRQ(ierr); 911408da460SShri Abhyankar ierr = ISGetSize(IS_act,&Nis_act);CHKERRQ(ierr); 912dbd914b8SShri Abhyankar 913d76c674bSShri Abhyankar ierr = PetscPrintf(PETSC_COMM_WORLD,"Size of active set = %d, size of inactive set = %d\n",nis_act,nis_inact);CHKERRQ(ierr); 914d76c674bSShri Abhyankar 915dbd914b8SShri Abhyankar /* Create active and inactive set vectors */ 916fe835674SShri Abhyankar ierr = SNESVICreateSubVectors(snes,nis_act,&Da_act);CHKERRQ(ierr); 917fe835674SShri Abhyankar ierr = SNESVICreateSubVectors(snes,nis_inact,&Da_inact);CHKERRQ(ierr); 918fe835674SShri Abhyankar ierr = SNESVICreateSubVectors(snes,nis_inact,&Db_inact);CHKERRQ(ierr); 919fe835674SShri Abhyankar ierr = SNESVICreateSubVectors(snes,nis_act,&phi_act);CHKERRQ(ierr); 920fe835674SShri Abhyankar ierr = SNESVICreateSubVectors(snes,nis_inact,&phi_inact);CHKERRQ(ierr); 921fe835674SShri Abhyankar ierr = SNESVICreateSubVectors(snes,nis_act,&Y_act);CHKERRQ(ierr); 922fe835674SShri Abhyankar ierr = SNESVICreateSubVectors(snes,nis_inact,&Y_inact);CHKERRQ(ierr); 923dbd914b8SShri Abhyankar 924dbd914b8SShri Abhyankar /* Create inactive set submatrices */ 925dbd914b8SShri Abhyankar ierr = MatGetSubMatrix(snes->jacobian,IS_inact,IS_act,MAT_INITIAL_MATRIX,&jac_inact_act);CHKERRQ(ierr); 926dbd914b8SShri Abhyankar ierr = MatGetSubMatrix(snes->jacobian,IS_inact,IS_inact,MAT_INITIAL_MATRIX,&jac_inact_inact);CHKERRQ(ierr); 927dbd914b8SShri Abhyankar 928dbd914b8SShri Abhyankar /* Create scatter contexts */ 929dbd914b8SShri Abhyankar ierr = VecScatterCreate(vi->Da,IS_act,Da_act,PETSC_NULL,&scat_act);CHKERRQ(ierr); 930dbd914b8SShri Abhyankar ierr = VecScatterCreate(vi->Da,IS_inact,Da_inact,PETSC_NULL,&scat_inact);CHKERRQ(ierr); 931dbd914b8SShri Abhyankar 932dbd914b8SShri Abhyankar /* Do a vec scatter to active and inactive set vectors */ 933dbd914b8SShri Abhyankar ierr = VecScatterBegin(scat_act,vi->Da,Da_act,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 934dbd914b8SShri Abhyankar ierr = VecScatterEnd(scat_act,vi->Da,Da_act,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 935dbd914b8SShri Abhyankar 936dbd914b8SShri Abhyankar ierr = VecScatterBegin(scat_inact,vi->Da,Da_inact,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 937dbd914b8SShri Abhyankar ierr = VecScatterEnd(scat_inact,vi->Da,Da_inact,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 938dbd914b8SShri Abhyankar 939dbd914b8SShri Abhyankar ierr = VecScatterBegin(scat_inact,vi->Db,Db_inact,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 940dbd914b8SShri Abhyankar ierr = VecScatterEnd(scat_inact,vi->Db,Db_inact,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 941dbd914b8SShri Abhyankar 942dbd914b8SShri Abhyankar ierr = VecScatterBegin(scat_act,vi->phi,phi_act,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 943dbd914b8SShri Abhyankar ierr = VecScatterEnd(scat_act,vi->phi,phi_act,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 944dbd914b8SShri Abhyankar 945dbd914b8SShri Abhyankar ierr = VecScatterBegin(scat_inact,vi->phi,phi_inact,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 946dbd914b8SShri Abhyankar ierr = VecScatterEnd(scat_inact,vi->phi,phi_inact,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 947dbd914b8SShri Abhyankar 948dbd914b8SShri Abhyankar ierr = VecScatterBegin(scat_act,Y,Y_act,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 949dbd914b8SShri Abhyankar ierr = VecScatterEnd(scat_act,Y,Y_act,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 950dbd914b8SShri Abhyankar 951dbd914b8SShri Abhyankar ierr = VecScatterBegin(scat_inact,Y,Y_inact,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 952dbd914b8SShri Abhyankar ierr = VecScatterEnd(scat_inact,Y,Y_inact,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 953dbd914b8SShri Abhyankar 954dbd914b8SShri Abhyankar /* Active set direction */ 955dbd914b8SShri Abhyankar ierr = VecPointwiseDivide(Y_act,phi_act,Da_act);CHKERRQ(ierr); 956d76c674bSShri Abhyankar /* inactive set jacobian and preconditioner */ 957dbd914b8SShri Abhyankar ierr = VecPointwiseDivide(Da_inact,Da_inact,Db_inact);CHKERRQ(ierr); 958dbd914b8SShri Abhyankar ierr = MatDiagonalSet(jac_inact_inact,Da_inact,ADD_VALUES);CHKERRQ(ierr); 959d76c674bSShri Abhyankar if (snes->jacobian != snes->jacobian_pre) { 960d76c674bSShri Abhyankar ierr = MatGetSubMatrix(snes->jacobian_pre,IS_inact,IS_inact,MAT_INITIAL_MATRIX,&prejac_inact_inact);CHKERRQ(ierr); 961d76c674bSShri Abhyankar ierr = MatDiagonalSet(prejac_inact_inact,Da_inact,ADD_VALUES);CHKERRQ(ierr); 962d76c674bSShri Abhyankar } else prejac_inact_inact = jac_inact_inact; 963d76c674bSShri Abhyankar 964dbd914b8SShri Abhyankar /* right hand side */ 965dbd914b8SShri Abhyankar ierr = VecPointwiseDivide(phi_inact,phi_inact,Db_inact);CHKERRQ(ierr); 966dbd914b8SShri Abhyankar ierr = MatMult(jac_inact_act,Y_act,Db_inact);CHKERRQ(ierr); 967dbd914b8SShri Abhyankar ierr = VecAXPY(phi_inact,-1.0,Db_inact);CHKERRQ(ierr); 968dbd914b8SShri Abhyankar 969408da460SShri Abhyankar if ((i != 0) && (Nis_act != Nis_act_prev)) { 970732bb160SShri Abhyankar ierr = SNESVIResetPCandKSP(snes,jac_inact_inact,prejac_inact_inact);CHKERRQ(ierr); 971408da460SShri Abhyankar } 972408da460SShri Abhyankar 973d76c674bSShri Abhyankar ierr = KSPSetOperators(snes->ksp,jac_inact_inact,prejac_inact_inact,flg);CHKERRQ(ierr); 974dbd914b8SShri Abhyankar ierr = SNES_KSPSolve(snes,snes->ksp,phi_inact,Y_inact);CHKERRQ(ierr); 975dbd914b8SShri Abhyankar ierr = KSPGetConvergedReason(snes->ksp,&kspreason);CHKERRQ(ierr); 9763b336b49SShri Abhyankar if (kspreason < 0) { 9773b336b49SShri Abhyankar if (++snes->numLinearSolveFailures >= snes->maxLinearSolveFailures) { 9783b336b49SShri 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); 9793b336b49SShri Abhyankar snes->reason = SNES_DIVERGED_LINEAR_SOLVE; 9803b336b49SShri Abhyankar break; 9813b336b49SShri Abhyankar } 9823b336b49SShri Abhyankar } 983dbd914b8SShri Abhyankar 984dbd914b8SShri Abhyankar ierr = VecScatterBegin(scat_act,Y_act,Y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 985dbd914b8SShri Abhyankar ierr = VecScatterEnd(scat_act,Y_act,Y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 986dbd914b8SShri Abhyankar ierr = VecScatterBegin(scat_inact,Y_inact,Y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 987dbd914b8SShri Abhyankar ierr = VecScatterEnd(scat_inact,Y_inact,Y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 988dbd914b8SShri Abhyankar 989dbd914b8SShri Abhyankar ierr = VecDestroy(Da_act);CHKERRQ(ierr); 990dbd914b8SShri Abhyankar ierr = VecDestroy(Da_inact);CHKERRQ(ierr); 991dbd914b8SShri Abhyankar ierr = VecDestroy(Db_inact);CHKERRQ(ierr); 992dbd914b8SShri Abhyankar ierr = VecDestroy(phi_act);CHKERRQ(ierr); 993dbd914b8SShri Abhyankar ierr = VecDestroy(phi_inact);CHKERRQ(ierr); 994dbd914b8SShri Abhyankar ierr = VecDestroy(Y_act);CHKERRQ(ierr); 995dbd914b8SShri Abhyankar ierr = VecDestroy(Y_inact);CHKERRQ(ierr); 996dbd914b8SShri Abhyankar ierr = VecScatterDestroy(scat_act);CHKERRQ(ierr); 997dbd914b8SShri Abhyankar ierr = VecScatterDestroy(scat_inact);CHKERRQ(ierr); 998730c24dcSShri Abhyankar ierr = ISDestroy(IS_act);CHKERRQ(ierr); 999730c24dcSShri Abhyankar ierr = ISDestroy(IS_inact);CHKERRQ(ierr); 1000bac2f86eSShri Abhyankar ierr = MatDestroy(jac_inact_act);CHKERRQ(ierr); 1001bac2f86eSShri Abhyankar ierr = MatDestroy(jac_inact_inact);CHKERRQ(ierr); 1002d76c674bSShri Abhyankar if (snes->jacobian != snes->jacobian_pre) { 1003d76c674bSShri Abhyankar ierr = MatDestroy(prejac_inact_inact);CHKERRQ(ierr); 1004d76c674bSShri Abhyankar } 1005730c24dcSShri Abhyankar 100669c03620SShri Abhyankar ierr = KSPGetIterationNumber(snes->ksp,&lits);CHKERRQ(ierr); 100769c03620SShri Abhyankar snes->linear_its += lits; 100869c03620SShri Abhyankar ierr = PetscInfo2(snes,"iter=%D, linear solve iterations=%D\n",snes->iter,lits);CHKERRQ(ierr); 100969c03620SShri Abhyankar /* 101069c03620SShri Abhyankar if (vi->precheckstep) { 101169c03620SShri Abhyankar PetscBool changed_y = PETSC_FALSE; 101269c03620SShri Abhyankar ierr = (*vi->precheckstep)(snes,X,Y,vi->precheck,&changed_y);CHKERRQ(ierr); 101369c03620SShri Abhyankar } 101469c03620SShri Abhyankar 101569c03620SShri Abhyankar if (PetscLogPrintInfo){ 101669c03620SShri Abhyankar ierr = SNESVICheckResidual_Private(snes,snes->jacobian,F,Y,G,W);CHKERRQ(ierr); 101769c03620SShri Abhyankar } 101869c03620SShri Abhyankar */ 101969c03620SShri Abhyankar /* Compute a (scaled) negative update in the line search routine: 102069c03620SShri Abhyankar Y <- X - lambda*Y 102169c03620SShri Abhyankar and evaluate G = function(Y) (depends on the line search). 102269c03620SShri Abhyankar */ 102369c03620SShri Abhyankar ierr = VecCopy(Y,snes->vec_sol_update);CHKERRQ(ierr); 102469c03620SShri Abhyankar ynorm = 1; gnorm = vi->phinorm; 10253b336b49SShri Abhyankar ierr = SNESVIComputeJacobian(snes->jacobian,snes->jacobian_pre,vi->Da,vi->Db);CHKERRQ(ierr); 1026ee657d29SShri Abhyankar ierr = SNESVIComputeMeritFunctionGradient(snes->jacobian,vi->phi,vi->dpsi);CHKERRQ(ierr); 102769c03620SShri Abhyankar ierr = (*vi->LineSearch)(snes,vi->lsP,X,vi->phi,G,Y,W,vi->phinorm,xnorm,&ynorm,&gnorm,&lssucceed);CHKERRQ(ierr); 102869c03620SShri Abhyankar ierr = PetscInfo4(snes,"fnorm=%18.16e, gnorm=%18.16e, ynorm=%18.16e, lssucceed=%d\n",vi->phinorm,gnorm,ynorm,(int)lssucceed);CHKERRQ(ierr); 102969c03620SShri Abhyankar if (snes->reason == SNES_DIVERGED_FUNCTION_COUNT) break; 103069c03620SShri Abhyankar if (snes->domainerror) { 103169c03620SShri Abhyankar snes->reason = SNES_DIVERGED_FUNCTION_DOMAIN; 10329ce7406fSBarry Smith snes->ops->computefunction = vi->computeuserfunction; 103369c03620SShri Abhyankar PetscFunctionReturn(0); 103469c03620SShri Abhyankar } 103569c03620SShri Abhyankar if (!lssucceed) { 103669c03620SShri Abhyankar if (++snes->numFailures >= snes->maxFailures) { 103769c03620SShri Abhyankar PetscBool ismin; 103869c03620SShri Abhyankar snes->reason = SNES_DIVERGED_LINE_SEARCH; 103969c03620SShri Abhyankar ierr = SNESVICheckLocalMin_Private(snes,snes->jacobian,G,W,gnorm,&ismin);CHKERRQ(ierr); 104069c03620SShri Abhyankar if (ismin) snes->reason = SNES_DIVERGED_LOCAL_MIN; 104169c03620SShri Abhyankar break; 104269c03620SShri Abhyankar } 104369c03620SShri Abhyankar } 104469c03620SShri Abhyankar /* Update function and solution vectors */ 104569c03620SShri Abhyankar vi->phinorm = gnorm; 104669c03620SShri Abhyankar vi->merit = 0.5*vi->phinorm*vi->phinorm; 104769c03620SShri Abhyankar ierr = VecCopy(G,vi->phi);CHKERRQ(ierr); 104869c03620SShri Abhyankar ierr = VecCopy(W,X);CHKERRQ(ierr); 104969c03620SShri Abhyankar /* Monitor convergence */ 105069c03620SShri Abhyankar ierr = PetscObjectTakeAccess(snes);CHKERRQ(ierr); 105169c03620SShri Abhyankar snes->iter = i+1; 105269c03620SShri Abhyankar snes->norm = vi->phinorm; 105369c03620SShri Abhyankar ierr = PetscObjectGrantAccess(snes);CHKERRQ(ierr); 105469c03620SShri Abhyankar SNESLogConvHistory(snes,snes->norm,lits); 105569c03620SShri Abhyankar SNESMonitor(snes,snes->iter,snes->norm); 105669c03620SShri Abhyankar /* Test for convergence, xnorm = || X || */ 105769c03620SShri Abhyankar if (snes->ops->converged != SNESSkipConverged) { ierr = VecNorm(X,NORM_2,&xnorm);CHKERRQ(ierr); } 105869c03620SShri Abhyankar ierr = (*snes->ops->converged)(snes,snes->iter,xnorm,ynorm,vi->phinorm,&snes->reason,snes->cnvP);CHKERRQ(ierr); 105969c03620SShri Abhyankar if (snes->reason) break; 106069c03620SShri Abhyankar } 106169c03620SShri Abhyankar if (i == maxits) { 106269c03620SShri Abhyankar ierr = PetscInfo1(snes,"Maximum number of iterations has been reached: %D\n",maxits);CHKERRQ(ierr); 106369c03620SShri Abhyankar if(!snes->reason) snes->reason = SNES_DIVERGED_MAX_IT; 106469c03620SShri Abhyankar } 10659ce7406fSBarry Smith snes->ops->computefunction = vi->computeuserfunction; 106669c03620SShri Abhyankar PetscFunctionReturn(0); 106769c03620SShri Abhyankar } 106869c03620SShri Abhyankar 1069fe835674SShri Abhyankar #undef __FUNCT__ 1070fe835674SShri Abhyankar #define __FUNCT__ "SNESVIComputeInactiveSetFnorm" 1071fe835674SShri Abhyankar PetscErrorCode SNESVIComputeInactiveSetFnorm(SNES snes,Vec F,Vec X,PetscScalar *fnorm) 1072fe835674SShri Abhyankar { 1073fe835674SShri Abhyankar PetscErrorCode ierr; 1074fe835674SShri Abhyankar SNES_VI *vi = (SNES_VI*)snes->data; 1075fe835674SShri Abhyankar const PetscScalar *x,*xl,*xu,*f; 1076fe835674SShri Abhyankar PetscInt i,n; 1077fe835674SShri Abhyankar PetscReal rnorm; 1078fe835674SShri Abhyankar 1079fe835674SShri Abhyankar PetscFunctionBegin; 1080fe835674SShri Abhyankar 1081fe835674SShri Abhyankar ierr = VecGetLocalSize(X,&n);CHKERRQ(ierr); 1082fe835674SShri Abhyankar ierr = VecGetArrayRead(vi->xl,&xl);CHKERRQ(ierr); 1083fe835674SShri Abhyankar ierr = VecGetArrayRead(vi->xu,&xu);CHKERRQ(ierr); 1084fe835674SShri Abhyankar ierr = VecGetArrayRead(X,&x);CHKERRQ(ierr); 1085fe835674SShri Abhyankar ierr = VecGetArrayRead(F,&f);CHKERRQ(ierr); 1086fe835674SShri Abhyankar 1087fe835674SShri Abhyankar rnorm = 0.0; 1088fe835674SShri Abhyankar for (i=0; i<n; i++) { 1089fe835674SShri 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]; 1090fe835674SShri Abhyankar } 1091fe835674SShri Abhyankar ierr = VecRestoreArrayRead(F,&f);CHKERRQ(ierr); 1092fe835674SShri Abhyankar ierr = VecRestoreArrayRead(vi->xl,&xl);CHKERRQ(ierr); 1093fe835674SShri Abhyankar ierr = VecRestoreArrayRead(vi->xu,&xu);CHKERRQ(ierr); 1094fe835674SShri Abhyankar ierr = VecRestoreArrayRead(X,&x);CHKERRQ(ierr); 1095fe835674SShri Abhyankar ierr = MPI_Allreduce(&rnorm,fnorm,1,MPIU_REAL,MPI_SUM,((PetscObject)snes)->comm);CHKERRQ(ierr); 1096fe835674SShri Abhyankar *fnorm = sqrt(*fnorm); 1097fe835674SShri Abhyankar PetscFunctionReturn(0); 1098fe835674SShri Abhyankar } 1099fe835674SShri Abhyankar 1100fe835674SShri Abhyankar /* Variational Inequality solver using reduce space method. No semismooth algorithm is 1101fe835674SShri Abhyankar implemented in this algorithm. It basically identifies the active variables and does 1102fe835674SShri Abhyankar a linear solve on the inactive variables. */ 1103d950fb63SShri Abhyankar #undef __FUNCT__ 1104d950fb63SShri Abhyankar #define __FUNCT__ "SNESSolveVI_RS" 1105d950fb63SShri Abhyankar PetscErrorCode SNESSolveVI_RS(SNES snes) 1106d950fb63SShri Abhyankar { 1107d950fb63SShri Abhyankar SNES_VI *vi = (SNES_VI*)snes->data; 1108d950fb63SShri Abhyankar PetscErrorCode ierr; 110964221577SShri Abhyankar PetscInt maxits,i,lits,Nis_inact; 1110d950fb63SShri Abhyankar PetscBool lssucceed; 1111d950fb63SShri Abhyankar MatStructure flg = DIFFERENT_NONZERO_PATTERN; 1112fe835674SShri Abhyankar PetscReal fnorm,gnorm,xnorm=0,ynorm; 1113d950fb63SShri Abhyankar Vec Y,X,F,G,W; 1114d950fb63SShri Abhyankar KSPConvergedReason kspreason; 1115d950fb63SShri Abhyankar 1116d950fb63SShri Abhyankar PetscFunctionBegin; 1117d950fb63SShri Abhyankar snes->numFailures = 0; 1118d950fb63SShri Abhyankar snes->numLinearSolveFailures = 0; 1119d950fb63SShri Abhyankar snes->reason = SNES_CONVERGED_ITERATING; 1120d950fb63SShri Abhyankar 1121d950fb63SShri Abhyankar maxits = snes->max_its; /* maximum number of iterations */ 1122d950fb63SShri Abhyankar X = snes->vec_sol; /* solution vector */ 1123d950fb63SShri Abhyankar F = snes->vec_func; /* residual vector */ 1124d950fb63SShri Abhyankar Y = snes->work[0]; /* work vectors */ 1125d950fb63SShri Abhyankar G = snes->work[1]; 1126d950fb63SShri Abhyankar W = snes->work[2]; 1127d950fb63SShri Abhyankar 112864221577SShri Abhyankar Nis_inact = F->map->N; 1129d950fb63SShri Abhyankar ierr = PetscObjectTakeAccess(snes);CHKERRQ(ierr); 1130d950fb63SShri Abhyankar snes->iter = 0; 1131d950fb63SShri Abhyankar snes->norm = 0.0; 1132d950fb63SShri Abhyankar ierr = PetscObjectGrantAccess(snes);CHKERRQ(ierr); 1133d950fb63SShri Abhyankar 1134d950fb63SShri Abhyankar ierr = SNESVIAdjustInitialGuess(X,vi->xl,vi->xu);CHKERRQ(ierr); 1135fe835674SShri Abhyankar ierr = SNESComputeFunction(snes,X,F);CHKERRQ(ierr); 1136d950fb63SShri Abhyankar if (snes->domainerror) { 1137d950fb63SShri Abhyankar snes->reason = SNES_DIVERGED_FUNCTION_DOMAIN; 1138d950fb63SShri Abhyankar PetscFunctionReturn(0); 1139d950fb63SShri Abhyankar } 1140fe835674SShri Abhyankar ierr = SNESVIComputeInactiveSetFnorm(snes,F,X,&fnorm);CHKERRQ(ierr); 1141d950fb63SShri Abhyankar ierr = VecNormBegin(X,NORM_2,&xnorm);CHKERRQ(ierr); /* xnorm <- ||x|| */ 1142d950fb63SShri Abhyankar ierr = VecNormEnd(X,NORM_2,&xnorm);CHKERRQ(ierr); 1143fe835674SShri Abhyankar if PetscIsInfOrNanReal(fnorm) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FP,"User provided compute function generated a Not-a-Number"); 1144d950fb63SShri Abhyankar 1145d950fb63SShri Abhyankar ierr = PetscObjectTakeAccess(snes);CHKERRQ(ierr); 1146fe835674SShri Abhyankar snes->norm = fnorm; 1147d950fb63SShri Abhyankar ierr = PetscObjectGrantAccess(snes);CHKERRQ(ierr); 1148fe835674SShri Abhyankar SNESLogConvHistory(snes,fnorm,0); 1149fe835674SShri Abhyankar SNESMonitor(snes,0,fnorm); 1150d950fb63SShri Abhyankar 1151d950fb63SShri Abhyankar /* set parameter for default relative tolerance convergence test */ 1152fe835674SShri Abhyankar snes->ttol = fnorm*snes->rtol; 1153d950fb63SShri Abhyankar /* test convergence */ 1154fe835674SShri Abhyankar ierr = (*snes->ops->converged)(snes,0,0.0,0.0,fnorm,&snes->reason,snes->cnvP);CHKERRQ(ierr); 1155d950fb63SShri Abhyankar if (snes->reason) PetscFunctionReturn(0); 1156d950fb63SShri Abhyankar 1157d950fb63SShri Abhyankar for (i=0; i<maxits; i++) { 1158d950fb63SShri Abhyankar 1159d950fb63SShri Abhyankar IS IS_act,IS_inact; /* _act -> active set _inact -> inactive set */ 1160d950fb63SShri Abhyankar VecScatter scat_act,scat_inact; 116164221577SShri Abhyankar PetscInt nis_act,nis_inact,Nis_inact_prev; 1162fe835674SShri Abhyankar Vec Y_act,Y_inact,F_inact; 1163d950fb63SShri Abhyankar Mat jac_inact_inact,prejac_inact_inact; 1164d950fb63SShri Abhyankar 1165d950fb63SShri Abhyankar /* Call general purpose update function */ 1166d950fb63SShri Abhyankar if (snes->ops->update) { 1167d950fb63SShri Abhyankar ierr = (*snes->ops->update)(snes, snes->iter);CHKERRQ(ierr); 1168d950fb63SShri Abhyankar } 1169d950fb63SShri Abhyankar ierr = SNESComputeJacobian(snes,X,&snes->jacobian,&snes->jacobian_pre,&flg);CHKERRQ(ierr); 1170d950fb63SShri Abhyankar /* Create active and inactive index sets */ 1171d950fb63SShri Abhyankar ierr = SNESVICreateIndexSets_RS(snes,X,vi->xl,vi->xu,&IS_act,&IS_inact);CHKERRQ(ierr); 1172d950fb63SShri Abhyankar 117364221577SShri Abhyankar Nis_inact_prev = Nis_inact; 1174d950fb63SShri Abhyankar /* Get sizes of active and inactive sets */ 1175d950fb63SShri Abhyankar ierr = ISGetLocalSize(IS_act,&nis_act);CHKERRQ(ierr); 1176d950fb63SShri Abhyankar ierr = ISGetLocalSize(IS_inact,&nis_inact);CHKERRQ(ierr); 117764221577SShri Abhyankar ierr = ISGetSize(IS_inact,&Nis_inact);CHKERRQ(ierr); 1178d950fb63SShri Abhyankar 1179d950fb63SShri Abhyankar ierr = PetscPrintf(PETSC_COMM_WORLD,"Size of active set = %d, size of inactive set = %d\n",nis_act,nis_inact);CHKERRQ(ierr); 1180d950fb63SShri Abhyankar 1181d950fb63SShri Abhyankar /* Create active and inactive set vectors */ 1182fe835674SShri Abhyankar ierr = SNESVICreateSubVectors(snes,nis_inact,&F_inact);CHKERRQ(ierr); 1183fe835674SShri Abhyankar ierr = SNESVICreateSubVectors(snes,nis_act,&Y_act);CHKERRQ(ierr); 1184fe835674SShri Abhyankar ierr = SNESVICreateSubVectors(snes,nis_inact,&Y_inact);CHKERRQ(ierr); 1185d950fb63SShri Abhyankar 1186d950fb63SShri Abhyankar /* Create inactive set submatrices */ 1187d950fb63SShri Abhyankar ierr = MatGetSubMatrix(snes->jacobian,IS_inact,IS_inact,MAT_INITIAL_MATRIX,&jac_inact_inact);CHKERRQ(ierr); 1188d950fb63SShri Abhyankar 1189d950fb63SShri Abhyankar /* Create scatter contexts */ 1190d950fb63SShri Abhyankar ierr = VecScatterCreate(Y,IS_act,Y_act,PETSC_NULL,&scat_act);CHKERRQ(ierr); 1191d950fb63SShri Abhyankar ierr = VecScatterCreate(Y,IS_inact,Y_inact,PETSC_NULL,&scat_inact);CHKERRQ(ierr); 1192d950fb63SShri Abhyankar 1193d950fb63SShri Abhyankar /* Do a vec scatter to active and inactive set vectors */ 1194fe835674SShri Abhyankar ierr = VecScatterBegin(scat_inact,F,F_inact,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 1195fe835674SShri Abhyankar ierr = VecScatterEnd(scat_inact,F,F_inact,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 1196d950fb63SShri Abhyankar 1197d950fb63SShri Abhyankar ierr = VecScatterBegin(scat_act,Y,Y_act,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 1198d950fb63SShri Abhyankar ierr = VecScatterEnd(scat_act,Y,Y_act,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 1199d950fb63SShri Abhyankar 1200d950fb63SShri Abhyankar ierr = VecScatterBegin(scat_inact,Y,Y_inact,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 1201d950fb63SShri Abhyankar ierr = VecScatterEnd(scat_inact,Y,Y_inact,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 1202d950fb63SShri Abhyankar 1203d950fb63SShri Abhyankar /* Active set direction = 0 */ 1204d950fb63SShri Abhyankar ierr = VecSet(Y_act,0);CHKERRQ(ierr); 1205d950fb63SShri Abhyankar if (snes->jacobian != snes->jacobian_pre) { 1206d950fb63SShri Abhyankar ierr = MatGetSubMatrix(snes->jacobian_pre,IS_inact,IS_inact,MAT_INITIAL_MATRIX,&prejac_inact_inact);CHKERRQ(ierr); 1207d950fb63SShri Abhyankar } else prejac_inact_inact = jac_inact_inact; 1208d950fb63SShri Abhyankar 120964221577SShri Abhyankar if (Nis_inact != Nis_inact_prev) { 1210732bb160SShri Abhyankar ierr = SNESVIResetPCandKSP(snes,jac_inact_inact,prejac_inact_inact);CHKERRQ(ierr); 1211d950fb63SShri Abhyankar } 1212d950fb63SShri Abhyankar 1213d950fb63SShri Abhyankar ierr = KSPSetOperators(snes->ksp,jac_inact_inact,prejac_inact_inact,flg);CHKERRQ(ierr); 1214fe835674SShri Abhyankar ierr = SNES_KSPSolve(snes,snes->ksp,F_inact,Y_inact);CHKERRQ(ierr); 1215d950fb63SShri Abhyankar ierr = KSPGetConvergedReason(snes->ksp,&kspreason);CHKERRQ(ierr); 1216d950fb63SShri Abhyankar if (kspreason < 0) { 1217d950fb63SShri Abhyankar if (++snes->numLinearSolveFailures >= snes->maxLinearSolveFailures) { 1218d950fb63SShri 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); 1219d950fb63SShri Abhyankar snes->reason = SNES_DIVERGED_LINEAR_SOLVE; 1220d950fb63SShri Abhyankar break; 1221d950fb63SShri Abhyankar } 1222d950fb63SShri Abhyankar } 1223d950fb63SShri Abhyankar 1224d950fb63SShri Abhyankar ierr = VecScatterBegin(scat_act,Y_act,Y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 1225d950fb63SShri Abhyankar ierr = VecScatterEnd(scat_act,Y_act,Y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 1226d950fb63SShri Abhyankar ierr = VecScatterBegin(scat_inact,Y_inact,Y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 1227d950fb63SShri Abhyankar ierr = VecScatterEnd(scat_inact,Y_inact,Y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 1228d950fb63SShri Abhyankar 1229fe835674SShri Abhyankar ierr = VecDestroy(F_inact);CHKERRQ(ierr); 1230d950fb63SShri Abhyankar ierr = VecDestroy(Y_act);CHKERRQ(ierr); 1231d950fb63SShri Abhyankar ierr = VecDestroy(Y_inact);CHKERRQ(ierr); 1232d950fb63SShri Abhyankar ierr = VecScatterDestroy(scat_act);CHKERRQ(ierr); 1233d950fb63SShri Abhyankar ierr = VecScatterDestroy(scat_inact);CHKERRQ(ierr); 1234d950fb63SShri Abhyankar ierr = ISDestroy(IS_act);CHKERRQ(ierr); 1235d950fb63SShri Abhyankar ierr = ISDestroy(IS_inact);CHKERRQ(ierr); 1236d950fb63SShri Abhyankar ierr = MatDestroy(jac_inact_inact);CHKERRQ(ierr); 1237d950fb63SShri Abhyankar if (snes->jacobian != snes->jacobian_pre) { 1238d950fb63SShri Abhyankar ierr = MatDestroy(prejac_inact_inact);CHKERRQ(ierr); 1239d950fb63SShri Abhyankar } 1240d950fb63SShri Abhyankar 1241d950fb63SShri Abhyankar ierr = KSPGetIterationNumber(snes->ksp,&lits);CHKERRQ(ierr); 1242d950fb63SShri Abhyankar snes->linear_its += lits; 1243d950fb63SShri Abhyankar ierr = PetscInfo2(snes,"iter=%D, linear solve iterations=%D\n",snes->iter,lits);CHKERRQ(ierr); 1244d950fb63SShri Abhyankar /* 1245d950fb63SShri Abhyankar if (vi->precheckstep) { 1246d950fb63SShri Abhyankar PetscBool changed_y = PETSC_FALSE; 1247d950fb63SShri Abhyankar ierr = (*vi->precheckstep)(snes,X,Y,vi->precheck,&changed_y);CHKERRQ(ierr); 1248d950fb63SShri Abhyankar } 1249d950fb63SShri Abhyankar 1250d950fb63SShri Abhyankar if (PetscLogPrintInfo){ 1251d950fb63SShri Abhyankar ierr = SNESVICheckResidual_Private(snes,snes->jacobian,F,Y,G,W);CHKERRQ(ierr); 1252d950fb63SShri Abhyankar } 1253d950fb63SShri Abhyankar */ 1254d950fb63SShri Abhyankar /* Compute a (scaled) negative update in the line search routine: 1255d950fb63SShri Abhyankar Y <- X - lambda*Y 1256d950fb63SShri Abhyankar and evaluate G = function(Y) (depends on the line search). 1257d950fb63SShri Abhyankar */ 1258d950fb63SShri Abhyankar ierr = VecCopy(Y,snes->vec_sol_update);CHKERRQ(ierr); 1259fe835674SShri Abhyankar ynorm = 1; gnorm = fnorm; 1260fe835674SShri Abhyankar ierr = (*vi->LineSearch)(snes,vi->lsP,X,F,G,Y,W,fnorm,xnorm,&ynorm,&gnorm,&lssucceed);CHKERRQ(ierr); 1261fe835674SShri Abhyankar ierr = PetscInfo4(snes,"fnorm=%18.16e, gnorm=%18.16e, ynorm=%18.16e, lssucceed=%d\n",fnorm,gnorm,ynorm,(int)lssucceed);CHKERRQ(ierr); 12622b4ed282SShri Abhyankar if (snes->reason == SNES_DIVERGED_FUNCTION_COUNT) break; 12632b4ed282SShri Abhyankar if (snes->domainerror) { 12642b4ed282SShri Abhyankar snes->reason = SNES_DIVERGED_FUNCTION_DOMAIN; 12652b4ed282SShri Abhyankar PetscFunctionReturn(0); 12662b4ed282SShri Abhyankar } 12672b4ed282SShri Abhyankar if (!lssucceed) { 12682b4ed282SShri Abhyankar if (++snes->numFailures >= snes->maxFailures) { 12692b4ed282SShri Abhyankar PetscBool ismin; 12702b4ed282SShri Abhyankar snes->reason = SNES_DIVERGED_LINE_SEARCH; 12712b4ed282SShri Abhyankar ierr = SNESVICheckLocalMin_Private(snes,snes->jacobian,G,W,gnorm,&ismin);CHKERRQ(ierr); 12722b4ed282SShri Abhyankar if (ismin) snes->reason = SNES_DIVERGED_LOCAL_MIN; 12732b4ed282SShri Abhyankar break; 12742b4ed282SShri Abhyankar } 12752b4ed282SShri Abhyankar } 12762b4ed282SShri Abhyankar /* Update function and solution vectors */ 1277fe835674SShri Abhyankar fnorm = gnorm; 1278fe835674SShri Abhyankar ierr = VecCopy(G,F);CHKERRQ(ierr); 12792b4ed282SShri Abhyankar ierr = VecCopy(W,X);CHKERRQ(ierr); 12802b4ed282SShri Abhyankar /* Monitor convergence */ 12812b4ed282SShri Abhyankar ierr = PetscObjectTakeAccess(snes);CHKERRQ(ierr); 12822b4ed282SShri Abhyankar snes->iter = i+1; 1283fe835674SShri Abhyankar snes->norm = fnorm; 12842b4ed282SShri Abhyankar ierr = PetscObjectGrantAccess(snes);CHKERRQ(ierr); 12852b4ed282SShri Abhyankar SNESLogConvHistory(snes,snes->norm,lits); 12862b4ed282SShri Abhyankar SNESMonitor(snes,snes->iter,snes->norm); 12872b4ed282SShri Abhyankar /* Test for convergence, xnorm = || X || */ 12882b4ed282SShri Abhyankar if (snes->ops->converged != SNESSkipConverged) { ierr = VecNorm(X,NORM_2,&xnorm);CHKERRQ(ierr); } 1289fe835674SShri Abhyankar ierr = (*snes->ops->converged)(snes,snes->iter,xnorm,ynorm,fnorm,&snes->reason,snes->cnvP);CHKERRQ(ierr); 12902b4ed282SShri Abhyankar if (snes->reason) break; 12912b4ed282SShri Abhyankar } 12922b4ed282SShri Abhyankar if (i == maxits) { 12932b4ed282SShri Abhyankar ierr = PetscInfo1(snes,"Maximum number of iterations has been reached: %D\n",maxits);CHKERRQ(ierr); 12942b4ed282SShri Abhyankar if(!snes->reason) snes->reason = SNES_DIVERGED_MAX_IT; 12952b4ed282SShri Abhyankar } 12962b4ed282SShri Abhyankar PetscFunctionReturn(0); 12972b4ed282SShri Abhyankar } 12982b4ed282SShri Abhyankar 12992b4ed282SShri Abhyankar /* -------------------------------------------------------------------------- */ 13002b4ed282SShri Abhyankar /* 13012b4ed282SShri Abhyankar SNESSetUp_VI - Sets up the internal data structures for the later use 13022b4ed282SShri Abhyankar of the SNESVI nonlinear solver. 13032b4ed282SShri Abhyankar 13042b4ed282SShri Abhyankar Input Parameter: 13052b4ed282SShri Abhyankar . snes - the SNES context 13062b4ed282SShri Abhyankar . x - the solution vector 13072b4ed282SShri Abhyankar 13082b4ed282SShri Abhyankar Application Interface Routine: SNESSetUp() 13092b4ed282SShri Abhyankar 13102b4ed282SShri Abhyankar Notes: 13112b4ed282SShri Abhyankar For basic use of the SNES solvers, the user need not explicitly call 13122b4ed282SShri Abhyankar SNESSetUp(), since these actions will automatically occur during 13132b4ed282SShri Abhyankar the call to SNESSolve(). 13142b4ed282SShri Abhyankar */ 13152b4ed282SShri Abhyankar #undef __FUNCT__ 13162b4ed282SShri Abhyankar #define __FUNCT__ "SNESSetUp_VI" 13172b4ed282SShri Abhyankar PetscErrorCode SNESSetUp_VI(SNES snes) 13182b4ed282SShri Abhyankar { 13192b4ed282SShri Abhyankar PetscErrorCode ierr; 13202b4ed282SShri Abhyankar SNES_VI *vi = (SNES_VI*) snes->data; 13212b4ed282SShri Abhyankar PetscInt i_start[3],i_end[3]; 13222b4ed282SShri Abhyankar 13232b4ed282SShri Abhyankar PetscFunctionBegin; 13242b4ed282SShri Abhyankar if (!snes->vec_sol_update) { 13252b4ed282SShri Abhyankar ierr = VecDuplicate(snes->vec_sol,&snes->vec_sol_update);CHKERRQ(ierr); 13262b4ed282SShri Abhyankar ierr = PetscLogObjectParent(snes,snes->vec_sol_update);CHKERRQ(ierr); 13272b4ed282SShri Abhyankar } 13282b4ed282SShri Abhyankar if (!snes->work) { 13292b4ed282SShri Abhyankar snes->nwork = 3; 13302b4ed282SShri Abhyankar ierr = VecDuplicateVecs(snes->vec_sol,snes->nwork,&snes->work);CHKERRQ(ierr); 13312b4ed282SShri Abhyankar ierr = PetscLogObjectParents(snes,snes->nwork,snes->work);CHKERRQ(ierr); 13322b4ed282SShri Abhyankar } 13332b4ed282SShri Abhyankar 13342b4ed282SShri Abhyankar /* If the lower and upper bound on variables are not set, set it to 13352b4ed282SShri Abhyankar -Inf and Inf */ 13362b4ed282SShri Abhyankar if (!vi->xl && !vi->xu) { 13372b4ed282SShri Abhyankar vi->usersetxbounds = PETSC_FALSE; 13382b4ed282SShri Abhyankar ierr = VecDuplicate(snes->vec_sol, &vi->xl); CHKERRQ(ierr); 13392b4ed282SShri Abhyankar ierr = VecSet(vi->xl,PETSC_VI_NINF);CHKERRQ(ierr); 13402b4ed282SShri Abhyankar ierr = VecDuplicate(snes->vec_sol, &vi->xu); CHKERRQ(ierr); 13412b4ed282SShri Abhyankar ierr = VecSet(vi->xu,PETSC_VI_INF);CHKERRQ(ierr); 13422b4ed282SShri Abhyankar } else { 13432b4ed282SShri Abhyankar /* Check if lower bound, upper bound and solution vector distribution across the processors is identical */ 13442b4ed282SShri Abhyankar ierr = VecGetOwnershipRange(snes->vec_sol,i_start,i_end);CHKERRQ(ierr); 13452b4ed282SShri Abhyankar ierr = VecGetOwnershipRange(vi->xl,i_start+1,i_end+1);CHKERRQ(ierr); 13462b4ed282SShri Abhyankar ierr = VecGetOwnershipRange(vi->xu,i_start+2,i_end+2);CHKERRQ(ierr); 13472b4ed282SShri 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])) 13482b4ed282SShri 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."); 13492b4ed282SShri Abhyankar } 13502b4ed282SShri Abhyankar 1351fe835674SShri Abhyankar if (snes->ops->solve != SNESSolveVI_RS) { 1352fe835674SShri Abhyankar ierr = VecDuplicate(snes->vec_sol, &vi->dpsi);CHKERRQ(ierr); 1353fe835674SShri Abhyankar ierr = VecDuplicate(snes->vec_sol, &vi->phi); CHKERRQ(ierr); 1354fe835674SShri Abhyankar ierr = VecDuplicate(snes->vec_sol, &vi->Da); CHKERRQ(ierr); 1355fe835674SShri Abhyankar ierr = VecDuplicate(snes->vec_sol, &vi->Db); CHKERRQ(ierr); 1356fe835674SShri Abhyankar ierr = VecDuplicate(snes->vec_sol, &vi->z);CHKERRQ(ierr); 1357fe835674SShri Abhyankar ierr = VecDuplicate(snes->vec_sol, &vi->t); CHKERRQ(ierr); 1358fe835674SShri Abhyankar 1359fe835674SShri Abhyankar } 13602b4ed282SShri Abhyankar PetscFunctionReturn(0); 13612b4ed282SShri Abhyankar } 13622b4ed282SShri Abhyankar /* -------------------------------------------------------------------------- */ 13632b4ed282SShri Abhyankar /* 13642b4ed282SShri Abhyankar SNESDestroy_VI - Destroys the private SNES_VI context that was created 13652b4ed282SShri Abhyankar with SNESCreate_VI(). 13662b4ed282SShri Abhyankar 13672b4ed282SShri Abhyankar Input Parameter: 13682b4ed282SShri Abhyankar . snes - the SNES context 13692b4ed282SShri Abhyankar 13702b4ed282SShri Abhyankar Application Interface Routine: SNESDestroy() 13712b4ed282SShri Abhyankar */ 13722b4ed282SShri Abhyankar #undef __FUNCT__ 13732b4ed282SShri Abhyankar #define __FUNCT__ "SNESDestroy_VI" 13742b4ed282SShri Abhyankar PetscErrorCode SNESDestroy_VI(SNES snes) 13752b4ed282SShri Abhyankar { 13762b4ed282SShri Abhyankar SNES_VI *vi = (SNES_VI*) snes->data; 13772b4ed282SShri Abhyankar PetscErrorCode ierr; 13782b4ed282SShri Abhyankar 13792b4ed282SShri Abhyankar PetscFunctionBegin; 13802b4ed282SShri Abhyankar if (snes->vec_sol_update) { 13812b4ed282SShri Abhyankar ierr = VecDestroy(snes->vec_sol_update);CHKERRQ(ierr); 13822b4ed282SShri Abhyankar snes->vec_sol_update = PETSC_NULL; 13832b4ed282SShri Abhyankar } 13842b4ed282SShri Abhyankar if (snes->nwork) { 13852b4ed282SShri Abhyankar ierr = VecDestroyVecs(snes->work,snes->nwork);CHKERRQ(ierr); 13862b4ed282SShri Abhyankar snes->nwork = 0; 13872b4ed282SShri Abhyankar snes->work = PETSC_NULL; 13882b4ed282SShri Abhyankar } 13892b4ed282SShri Abhyankar 1390fe835674SShri Abhyankar if (snes->ops->solve != SNESSolveVI_RS) { 13912b4ed282SShri Abhyankar /* clear vectors */ 1392ee657d29SShri Abhyankar ierr = VecDestroy(vi->dpsi);CHKERRQ(ierr); 13932b4ed282SShri Abhyankar ierr = VecDestroy(vi->phi); CHKERRQ(ierr); 13942b4ed282SShri Abhyankar ierr = VecDestroy(vi->Da); CHKERRQ(ierr); 13952b4ed282SShri Abhyankar ierr = VecDestroy(vi->Db); CHKERRQ(ierr); 13962b4ed282SShri Abhyankar ierr = VecDestroy(vi->z); CHKERRQ(ierr); 13972b4ed282SShri Abhyankar ierr = VecDestroy(vi->t); CHKERRQ(ierr); 13982b4ed282SShri Abhyankar if (!vi->usersetxbounds) { 13992b4ed282SShri Abhyankar ierr = VecDestroy(vi->xl); CHKERRQ(ierr); 14002b4ed282SShri Abhyankar ierr = VecDestroy(vi->xu); CHKERRQ(ierr); 14012b4ed282SShri Abhyankar } 1402fe835674SShri Abhyankar } 1403c92abb8aSShri Abhyankar if (vi->lsmonitor) { 1404c92abb8aSShri Abhyankar ierr = PetscViewerASCIIMonitorDestroy(vi->lsmonitor);CHKERRQ(ierr); 14052b4ed282SShri Abhyankar } 14062b4ed282SShri Abhyankar ierr = PetscFree(snes->data);CHKERRQ(ierr); 14072b4ed282SShri Abhyankar 14082b4ed282SShri Abhyankar /* clear composed functions */ 14092b4ed282SShri Abhyankar ierr = PetscObjectComposeFunctionDynamic((PetscObject)snes,"SNESLineSearchSet_C","",PETSC_NULL);CHKERRQ(ierr); 1410c92abb8aSShri Abhyankar ierr = PetscObjectComposeFunctionDynamic((PetscObject)snes,"SNESLineSearchSetMonitor_C","",PETSC_NULL);CHKERRQ(ierr); 14112b4ed282SShri Abhyankar PetscFunctionReturn(0); 14122b4ed282SShri Abhyankar } 14132b4ed282SShri Abhyankar /* -------------------------------------------------------------------------- */ 14142b4ed282SShri Abhyankar #undef __FUNCT__ 14152b4ed282SShri Abhyankar #define __FUNCT__ "SNESLineSearchNo_VI" 14162b4ed282SShri Abhyankar 14172b4ed282SShri Abhyankar /* 14182b4ed282SShri Abhyankar This routine is a copy of SNESLineSearchNo routine in snes/impls/ls/ls.c 14192b4ed282SShri Abhyankar 14202b4ed282SShri Abhyankar */ 1421ace3abfcSBarry 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) 14222b4ed282SShri Abhyankar { 14232b4ed282SShri Abhyankar PetscErrorCode ierr; 14242b4ed282SShri Abhyankar SNES_VI *vi = (SNES_VI*)snes->data; 1425ace3abfcSBarry Smith PetscBool changed_w = PETSC_FALSE,changed_y = PETSC_FALSE; 14262b4ed282SShri Abhyankar 14272b4ed282SShri Abhyankar PetscFunctionBegin; 14282b4ed282SShri Abhyankar *flag = PETSC_TRUE; 14292b4ed282SShri Abhyankar ierr = PetscLogEventBegin(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr); 14302b4ed282SShri Abhyankar ierr = VecNorm(y,NORM_2,ynorm);CHKERRQ(ierr); /* ynorm = || y || */ 14312b4ed282SShri Abhyankar ierr = VecWAXPY(w,-1.0,y,x);CHKERRQ(ierr); /* w <- x - y */ 14322b4ed282SShri Abhyankar if (vi->postcheckstep) { 14332b4ed282SShri Abhyankar ierr = (*vi->postcheckstep)(snes,x,y,w,vi->postcheck,&changed_y,&changed_w);CHKERRQ(ierr); 14342b4ed282SShri Abhyankar } 14352b4ed282SShri Abhyankar if (changed_y) { 14362b4ed282SShri Abhyankar ierr = VecWAXPY(w,-1.0,y,x);CHKERRQ(ierr); /* w <- x - y */ 14372b4ed282SShri Abhyankar } 14382b4ed282SShri Abhyankar ierr = SNESComputeFunction(snes,w,g);CHKERRQ(ierr); 14392b4ed282SShri Abhyankar if (!snes->domainerror) { 14402b4ed282SShri Abhyankar ierr = VecNorm(g,NORM_2,gnorm);CHKERRQ(ierr); /* gnorm = || g || */ 14412b4ed282SShri Abhyankar if PetscIsInfOrNanReal(*gnorm) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FP,"User provided compute function generated a Not-a-Number"); 14422b4ed282SShri Abhyankar } 1443c92abb8aSShri Abhyankar if (vi->lsmonitor) { 1444c92abb8aSShri Abhyankar ierr = PetscViewerASCIIMonitorPrintf(vi->lsmonitor," Line search: Using full step: fnorm %G gnorm %G\n",fnorm,*gnorm);CHKERRQ(ierr); 1445c92abb8aSShri Abhyankar } 14462b4ed282SShri Abhyankar ierr = PetscLogEventEnd(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr); 14472b4ed282SShri Abhyankar PetscFunctionReturn(0); 14482b4ed282SShri Abhyankar } 14492b4ed282SShri Abhyankar 14502b4ed282SShri Abhyankar /* -------------------------------------------------------------------------- */ 14512b4ed282SShri Abhyankar #undef __FUNCT__ 1452c1a5e521SShri Abhyankar #define __FUNCT__ "SNESLineSearchBoundProjectedNo_VI" 1453c1a5e521SShri Abhyankar 1454c1a5e521SShri Abhyankar /* 1455c1a5e521SShri Abhyankar This routine does not actually do a line search but it takes a full newton 1456c1a5e521SShri Abhyankar step while ensuring that the new iterates remain within the constraints. 1457c1a5e521SShri Abhyankar 1458c1a5e521SShri Abhyankar */ 1459c1a5e521SShri Abhyankar PetscErrorCode SNESLineSearchBoundProjectedNo_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) 1460c1a5e521SShri Abhyankar { 1461c1a5e521SShri Abhyankar PetscErrorCode ierr; 1462c1a5e521SShri Abhyankar SNES_VI *vi = (SNES_VI*)snes->data; 1463c1a5e521SShri Abhyankar PetscBool changed_w = PETSC_FALSE,changed_y = PETSC_FALSE; 1464c1a5e521SShri Abhyankar 1465c1a5e521SShri Abhyankar PetscFunctionBegin; 1466c1a5e521SShri Abhyankar *flag = PETSC_TRUE; 1467c1a5e521SShri Abhyankar ierr = PetscLogEventBegin(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr); 1468c1a5e521SShri Abhyankar ierr = VecNorm(y,NORM_2,ynorm);CHKERRQ(ierr); /* ynorm = || y || */ 1469c1a5e521SShri Abhyankar ierr = VecWAXPY(w,-1.0,y,x);CHKERRQ(ierr); /* w <- x - y */ 1470c1a5e521SShri Abhyankar ierr = SNESVIProjectOntoBounds(snes,w);CHKERRQ(ierr); 1471c1a5e521SShri Abhyankar if (vi->postcheckstep) { 1472c1a5e521SShri Abhyankar ierr = (*vi->postcheckstep)(snes,x,y,w,vi->postcheck,&changed_y,&changed_w);CHKERRQ(ierr); 1473c1a5e521SShri Abhyankar } 1474c1a5e521SShri Abhyankar if (changed_y) { 1475c1a5e521SShri Abhyankar ierr = VecWAXPY(w,-1.0,y,x);CHKERRQ(ierr); /* w <- x - y */ 1476c1a5e521SShri Abhyankar } 1477c1a5e521SShri Abhyankar ierr = SNESVIProjectOntoBounds(snes,w);CHKERRQ(ierr); 1478c1a5e521SShri Abhyankar ierr = SNESComputeFunction(snes,w,g);CHKERRQ(ierr); 1479c1a5e521SShri Abhyankar if (!snes->domainerror) { 1480c1a5e521SShri Abhyankar ierr = VecNorm(g,NORM_2,gnorm);CHKERRQ(ierr); /* gnorm = || g || */ 1481c1a5e521SShri Abhyankar if PetscIsInfOrNanReal(*gnorm) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FP,"User provided compute function generated a Not-a-Number"); 1482c1a5e521SShri Abhyankar } 1483c1a5e521SShri Abhyankar if (vi->lsmonitor) { 1484c1a5e521SShri Abhyankar ierr = PetscViewerASCIIMonitorPrintf(vi->lsmonitor," Line search: Using full step: fnorm %G gnorm %G\n",fnorm,*gnorm);CHKERRQ(ierr); 1485c1a5e521SShri Abhyankar } 1486c1a5e521SShri Abhyankar ierr = PetscLogEventEnd(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr); 1487c1a5e521SShri Abhyankar PetscFunctionReturn(0); 1488c1a5e521SShri Abhyankar } 1489c1a5e521SShri Abhyankar 1490c1a5e521SShri Abhyankar /* -------------------------------------------------------------------------- */ 1491c1a5e521SShri Abhyankar #undef __FUNCT__ 14922b4ed282SShri Abhyankar #define __FUNCT__ "SNESLineSearchNoNorms_VI" 14932b4ed282SShri Abhyankar 14942b4ed282SShri Abhyankar /* 14952b4ed282SShri Abhyankar This routine is a copy of SNESLineSearchNoNorms in snes/impls/ls/ls.c 14962b4ed282SShri Abhyankar */ 1497ace3abfcSBarry 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) 14982b4ed282SShri Abhyankar { 14992b4ed282SShri Abhyankar PetscErrorCode ierr; 15002b4ed282SShri Abhyankar SNES_VI *vi = (SNES_VI*)snes->data; 1501ace3abfcSBarry Smith PetscBool changed_w = PETSC_FALSE,changed_y = PETSC_FALSE; 15022b4ed282SShri Abhyankar 15032b4ed282SShri Abhyankar PetscFunctionBegin; 15042b4ed282SShri Abhyankar *flag = PETSC_TRUE; 15052b4ed282SShri Abhyankar ierr = PetscLogEventBegin(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr); 15062b4ed282SShri Abhyankar ierr = VecWAXPY(w,-1.0,y,x);CHKERRQ(ierr); /* w <- x - y */ 15072b4ed282SShri Abhyankar if (vi->postcheckstep) { 15082b4ed282SShri Abhyankar ierr = (*vi->postcheckstep)(snes,x,y,w,vi->postcheck,&changed_y,&changed_w);CHKERRQ(ierr); 15092b4ed282SShri Abhyankar } 15102b4ed282SShri Abhyankar if (changed_y) { 15112b4ed282SShri Abhyankar ierr = VecWAXPY(w,-1.0,y,x);CHKERRQ(ierr); /* w <- x - y */ 15122b4ed282SShri Abhyankar } 15132b4ed282SShri Abhyankar 15142b4ed282SShri Abhyankar /* don't evaluate function the last time through */ 15152b4ed282SShri Abhyankar if (snes->iter < snes->max_its-1) { 15162b4ed282SShri Abhyankar ierr = SNESComputeFunction(snes,w,g);CHKERRQ(ierr); 15172b4ed282SShri Abhyankar } 15182b4ed282SShri Abhyankar ierr = PetscLogEventEnd(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr); 15192b4ed282SShri Abhyankar PetscFunctionReturn(0); 15202b4ed282SShri Abhyankar } 15212b4ed282SShri Abhyankar /* -------------------------------------------------------------------------- */ 15222b4ed282SShri Abhyankar #undef __FUNCT__ 15232b4ed282SShri Abhyankar #define __FUNCT__ "SNESLineSearchCubic_VI" 15242b4ed282SShri Abhyankar /* 15252b4ed282SShri Abhyankar This routine is a copy of SNESLineSearchCubic in snes/impls/ls/ls.c 15262b4ed282SShri Abhyankar */ 1527ace3abfcSBarry 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) 15282b4ed282SShri Abhyankar { 15292b4ed282SShri Abhyankar /* 15302b4ed282SShri Abhyankar Note that for line search purposes we work with with the related 15312b4ed282SShri Abhyankar minimization problem: 15322b4ed282SShri Abhyankar min z(x): R^n -> R, 15332b4ed282SShri Abhyankar where z(x) = .5 * fnorm*fnorm, and fnorm = || f ||_2. 15342b4ed282SShri Abhyankar This function z(x) is same as the merit function for the complementarity problem. 15352b4ed282SShri Abhyankar */ 15362b4ed282SShri Abhyankar 15372b4ed282SShri Abhyankar PetscReal initslope,lambdaprev,gnormprev,a,b,d,t1,t2,rellength; 15382b4ed282SShri Abhyankar PetscReal minlambda,lambda,lambdatemp; 15392b4ed282SShri Abhyankar #if defined(PETSC_USE_COMPLEX) 15402b4ed282SShri Abhyankar PetscScalar cinitslope; 15412b4ed282SShri Abhyankar #endif 15422b4ed282SShri Abhyankar PetscErrorCode ierr; 15432b4ed282SShri Abhyankar PetscInt count; 15442b4ed282SShri Abhyankar SNES_VI *vi = (SNES_VI*)snes->data; 1545ace3abfcSBarry Smith PetscBool changed_w = PETSC_FALSE,changed_y = PETSC_FALSE; 15462b4ed282SShri Abhyankar MPI_Comm comm; 15472b4ed282SShri Abhyankar 15482b4ed282SShri Abhyankar PetscFunctionBegin; 15492b4ed282SShri Abhyankar ierr = PetscObjectGetComm((PetscObject)snes,&comm);CHKERRQ(ierr); 15502b4ed282SShri Abhyankar ierr = PetscLogEventBegin(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr); 15512b4ed282SShri Abhyankar *flag = PETSC_TRUE; 15522b4ed282SShri Abhyankar 15532b4ed282SShri Abhyankar ierr = VecNorm(y,NORM_2,ynorm);CHKERRQ(ierr); 15542b4ed282SShri Abhyankar if (*ynorm == 0.0) { 1555c92abb8aSShri Abhyankar if (vi->lsmonitor) { 1556c92abb8aSShri Abhyankar ierr = PetscViewerASCIIMonitorPrintf(vi->lsmonitor," Line search: Initial direction and size is 0\n");CHKERRQ(ierr); 15572b4ed282SShri Abhyankar } 15582b4ed282SShri Abhyankar *gnorm = fnorm; 15592b4ed282SShri Abhyankar ierr = VecCopy(x,w);CHKERRQ(ierr); 15602b4ed282SShri Abhyankar ierr = VecCopy(f,g);CHKERRQ(ierr); 15612b4ed282SShri Abhyankar *flag = PETSC_FALSE; 15622b4ed282SShri Abhyankar goto theend1; 15632b4ed282SShri Abhyankar } 15642b4ed282SShri Abhyankar if (*ynorm > vi->maxstep) { /* Step too big, so scale back */ 1565c92abb8aSShri Abhyankar if (vi->lsmonitor) { 1566c92abb8aSShri Abhyankar ierr = PetscViewerASCIIMonitorPrintf(vi->lsmonitor," Line search: Scaling step by %G old ynorm %G\n",vi->maxstep/(*ynorm),*ynorm);CHKERRQ(ierr); 15672b4ed282SShri Abhyankar } 15682b4ed282SShri Abhyankar ierr = VecScale(y,vi->maxstep/(*ynorm));CHKERRQ(ierr); 15692b4ed282SShri Abhyankar *ynorm = vi->maxstep; 15702b4ed282SShri Abhyankar } 15712b4ed282SShri Abhyankar ierr = VecMaxPointwiseDivide(y,x,&rellength);CHKERRQ(ierr); 15722b4ed282SShri Abhyankar minlambda = vi->minlambda/rellength; 15732b4ed282SShri Abhyankar #if defined(PETSC_USE_COMPLEX) 157489d9e806SShri Abhyankar ierr = VecDot(vi->dpsi,y,&cinitslope);CHKERRQ(ierr); 15752b4ed282SShri Abhyankar initslope = PetscRealPart(cinitslope); 15762b4ed282SShri Abhyankar #else 157789d9e806SShri Abhyankar ierr = VecDot(vi->dpsi,y,&initslope);CHKERRQ(ierr); 15782b4ed282SShri Abhyankar #endif 15792b4ed282SShri Abhyankar if (initslope > 0.0) initslope = -initslope; 15802b4ed282SShri Abhyankar if (initslope == 0.0) initslope = -1.0; 15812b4ed282SShri Abhyankar 15822b4ed282SShri Abhyankar ierr = VecWAXPY(w,-1.0,y,x);CHKERRQ(ierr); 15832b4ed282SShri Abhyankar if (snes->nfuncs >= snes->max_funcs) { 15842b4ed282SShri Abhyankar ierr = PetscInfo(snes,"Exceeded maximum function evaluations, while checking full step length!\n");CHKERRQ(ierr); 15852b4ed282SShri Abhyankar *flag = PETSC_FALSE; 15862b4ed282SShri Abhyankar snes->reason = SNES_DIVERGED_FUNCTION_COUNT; 15872b4ed282SShri Abhyankar goto theend1; 15882b4ed282SShri Abhyankar } 15892b4ed282SShri Abhyankar ierr = SNESComputeFunction(snes,w,g);CHKERRQ(ierr); 15902b4ed282SShri Abhyankar if (snes->domainerror) { 15912b4ed282SShri Abhyankar ierr = PetscLogEventEnd(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr); 15922b4ed282SShri Abhyankar PetscFunctionReturn(0); 15932b4ed282SShri Abhyankar } 15942b4ed282SShri Abhyankar ierr = VecNorm(g,NORM_2,gnorm);CHKERRQ(ierr); 15952b4ed282SShri Abhyankar if PetscIsInfOrNanReal(*gnorm) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FP,"User provided compute function generated a Not-a-Number"); 15962b4ed282SShri Abhyankar ierr = PetscInfo2(snes,"Initial fnorm %G gnorm %G\n",fnorm,*gnorm);CHKERRQ(ierr); 15972b4ed282SShri Abhyankar if (.5*(*gnorm)*(*gnorm) <= .5*fnorm*fnorm + vi->alpha*initslope) { /* Sufficient reduction */ 1598c92abb8aSShri Abhyankar if (vi->lsmonitor) { 1599c92abb8aSShri Abhyankar ierr = PetscViewerASCIIMonitorPrintf(vi->lsmonitor," Line search: Using full step: fnorm %G gnorm %G\n",fnorm,*gnorm);CHKERRQ(ierr); 16002b4ed282SShri Abhyankar } 16012b4ed282SShri Abhyankar goto theend1; 16022b4ed282SShri Abhyankar } 16032b4ed282SShri Abhyankar 16042b4ed282SShri Abhyankar /* Fit points with quadratic */ 16052b4ed282SShri Abhyankar lambda = 1.0; 16062b4ed282SShri Abhyankar lambdatemp = -initslope/((*gnorm)*(*gnorm) - fnorm*fnorm - 2.0*initslope); 16072b4ed282SShri Abhyankar lambdaprev = lambda; 16082b4ed282SShri Abhyankar gnormprev = *gnorm; 16092b4ed282SShri Abhyankar if (lambdatemp > .5*lambda) lambdatemp = .5*lambda; 16102b4ed282SShri Abhyankar if (lambdatemp <= .1*lambda) lambda = .1*lambda; 16112b4ed282SShri Abhyankar else lambda = lambdatemp; 16122b4ed282SShri Abhyankar 16132b4ed282SShri Abhyankar ierr = VecWAXPY(w,-lambda,y,x);CHKERRQ(ierr); 16142b4ed282SShri Abhyankar if (snes->nfuncs >= snes->max_funcs) { 16152b4ed282SShri Abhyankar ierr = PetscInfo1(snes,"Exceeded maximum function evaluations, while attempting quadratic backtracking! %D \n",snes->nfuncs);CHKERRQ(ierr); 16162b4ed282SShri Abhyankar *flag = PETSC_FALSE; 16172b4ed282SShri Abhyankar snes->reason = SNES_DIVERGED_FUNCTION_COUNT; 16182b4ed282SShri Abhyankar goto theend1; 16192b4ed282SShri Abhyankar } 16202b4ed282SShri Abhyankar ierr = SNESComputeFunction(snes,w,g);CHKERRQ(ierr); 16212b4ed282SShri Abhyankar if (snes->domainerror) { 16222b4ed282SShri Abhyankar ierr = PetscLogEventEnd(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr); 16232b4ed282SShri Abhyankar PetscFunctionReturn(0); 16242b4ed282SShri Abhyankar } 16252b4ed282SShri Abhyankar ierr = VecNorm(g,NORM_2,gnorm);CHKERRQ(ierr); 16262b4ed282SShri Abhyankar if PetscIsInfOrNanReal(*gnorm) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FP,"User provided compute function generated a Not-a-Number"); 1627c92abb8aSShri Abhyankar if (vi->lsmonitor) { 1628c92abb8aSShri Abhyankar ierr = PetscViewerASCIIMonitorPrintf(vi->lsmonitor," Line search: gnorm after quadratic fit %G\n",*gnorm);CHKERRQ(ierr); 16292b4ed282SShri Abhyankar } 16302b4ed282SShri Abhyankar if (.5*(*gnorm)*(*gnorm) < .5*fnorm*fnorm + lambda*vi->alpha*initslope) { /* sufficient reduction */ 1631c92abb8aSShri Abhyankar if (vi->lsmonitor) { 1632c92abb8aSShri Abhyankar ierr = PetscViewerASCIIMonitorPrintf(vi->lsmonitor," Line search: Quadratically determined step, lambda=%18.16e\n",lambda);CHKERRQ(ierr); 16332b4ed282SShri Abhyankar } 16342b4ed282SShri Abhyankar goto theend1; 16352b4ed282SShri Abhyankar } 16362b4ed282SShri Abhyankar 16372b4ed282SShri Abhyankar /* Fit points with cubic */ 16382b4ed282SShri Abhyankar count = 1; 16392b4ed282SShri Abhyankar while (PETSC_TRUE) { 16402b4ed282SShri Abhyankar if (lambda <= minlambda) { 1641c92abb8aSShri Abhyankar if (vi->lsmonitor) { 1642c92abb8aSShri Abhyankar ierr = PetscViewerASCIIMonitorPrintf(vi->lsmonitor," Line search: unable to find good step length! After %D tries \n",count);CHKERRQ(ierr); 1643c92abb8aSShri 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); 16442b4ed282SShri Abhyankar } 16452b4ed282SShri Abhyankar *flag = PETSC_FALSE; 16462b4ed282SShri Abhyankar break; 16472b4ed282SShri Abhyankar } 16482b4ed282SShri Abhyankar t1 = .5*((*gnorm)*(*gnorm) - fnorm*fnorm) - lambda*initslope; 16492b4ed282SShri Abhyankar t2 = .5*(gnormprev*gnormprev - fnorm*fnorm) - lambdaprev*initslope; 16502b4ed282SShri Abhyankar a = (t1/(lambda*lambda) - t2/(lambdaprev*lambdaprev))/(lambda-lambdaprev); 16512b4ed282SShri Abhyankar b = (-lambdaprev*t1/(lambda*lambda) + lambda*t2/(lambdaprev*lambdaprev))/(lambda-lambdaprev); 16522b4ed282SShri Abhyankar d = b*b - 3*a*initslope; 16532b4ed282SShri Abhyankar if (d < 0.0) d = 0.0; 16542b4ed282SShri Abhyankar if (a == 0.0) { 16552b4ed282SShri Abhyankar lambdatemp = -initslope/(2.0*b); 16562b4ed282SShri Abhyankar } else { 16572b4ed282SShri Abhyankar lambdatemp = (-b + sqrt(d))/(3.0*a); 16582b4ed282SShri Abhyankar } 16592b4ed282SShri Abhyankar lambdaprev = lambda; 16602b4ed282SShri Abhyankar gnormprev = *gnorm; 16612b4ed282SShri Abhyankar if (lambdatemp > .5*lambda) lambdatemp = .5*lambda; 16622b4ed282SShri Abhyankar if (lambdatemp <= .1*lambda) lambda = .1*lambda; 16632b4ed282SShri Abhyankar else lambda = lambdatemp; 16642b4ed282SShri Abhyankar ierr = VecWAXPY(w,-lambda,y,x);CHKERRQ(ierr); 16652b4ed282SShri Abhyankar if (snes->nfuncs >= snes->max_funcs) { 16662b4ed282SShri Abhyankar ierr = PetscInfo1(snes,"Exceeded maximum function evaluations, while looking for good step length! %D \n",count);CHKERRQ(ierr); 16672b4ed282SShri 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); 16682b4ed282SShri Abhyankar *flag = PETSC_FALSE; 16692b4ed282SShri Abhyankar snes->reason = SNES_DIVERGED_FUNCTION_COUNT; 16702b4ed282SShri Abhyankar break; 16712b4ed282SShri Abhyankar } 16722b4ed282SShri Abhyankar ierr = SNESComputeFunction(snes,w,g);CHKERRQ(ierr); 16732b4ed282SShri Abhyankar if (snes->domainerror) { 16742b4ed282SShri Abhyankar ierr = PetscLogEventEnd(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr); 16752b4ed282SShri Abhyankar PetscFunctionReturn(0); 16762b4ed282SShri Abhyankar } 16772b4ed282SShri Abhyankar ierr = VecNorm(g,NORM_2,gnorm);CHKERRQ(ierr); 16782b4ed282SShri Abhyankar if PetscIsInfOrNanReal(*gnorm) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FP,"User provided compute function generated a Not-a-Number"); 16792b4ed282SShri Abhyankar if (.5*(*gnorm)*(*gnorm) < .5*fnorm*fnorm + lambda*vi->alpha*initslope) { /* is reduction enough? */ 1680c92abb8aSShri Abhyankar if (vi->lsmonitor) { 16812b4ed282SShri Abhyankar ierr = PetscPrintf(comm," Line search: Cubically determined step, current gnorm %G lambda=%18.16e\n",*gnorm,lambda);CHKERRQ(ierr); 16822b4ed282SShri Abhyankar } 16832b4ed282SShri Abhyankar break; 16842b4ed282SShri Abhyankar } else { 1685c92abb8aSShri Abhyankar if (vi->lsmonitor) { 16862b4ed282SShri Abhyankar ierr = PetscPrintf(comm," Line search: Cubic step no good, shrinking lambda, current gnorm %G lambda=%18.16e\n",*gnorm,lambda);CHKERRQ(ierr); 16872b4ed282SShri Abhyankar } 16882b4ed282SShri Abhyankar } 16892b4ed282SShri Abhyankar count++; 16902b4ed282SShri Abhyankar } 16912b4ed282SShri Abhyankar theend1: 16922b4ed282SShri Abhyankar /* Optional user-defined check for line search step validity */ 16932b4ed282SShri Abhyankar if (vi->postcheckstep && *flag) { 16942b4ed282SShri Abhyankar ierr = (*vi->postcheckstep)(snes,x,y,w,vi->postcheck,&changed_y,&changed_w);CHKERRQ(ierr); 16952b4ed282SShri Abhyankar if (changed_y) { 16962b4ed282SShri Abhyankar ierr = VecWAXPY(w,-1.0,y,x);CHKERRQ(ierr); 16972b4ed282SShri Abhyankar } 16982b4ed282SShri Abhyankar if (changed_y || changed_w) { /* recompute the function if the step has changed */ 16992b4ed282SShri Abhyankar ierr = SNESComputeFunction(snes,w,g);CHKERRQ(ierr); 17002b4ed282SShri Abhyankar if (snes->domainerror) { 17012b4ed282SShri Abhyankar ierr = PetscLogEventEnd(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr); 17022b4ed282SShri Abhyankar PetscFunctionReturn(0); 17032b4ed282SShri Abhyankar } 17042b4ed282SShri Abhyankar ierr = VecNormBegin(g,NORM_2,gnorm);CHKERRQ(ierr); 17052b4ed282SShri Abhyankar if PetscIsInfOrNanReal(*gnorm) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FP,"User provided compute function generated a Not-a-Number"); 17062b4ed282SShri Abhyankar ierr = VecNormBegin(y,NORM_2,ynorm);CHKERRQ(ierr); 17072b4ed282SShri Abhyankar ierr = VecNormEnd(g,NORM_2,gnorm);CHKERRQ(ierr); 17082b4ed282SShri Abhyankar ierr = VecNormEnd(y,NORM_2,ynorm);CHKERRQ(ierr); 17092b4ed282SShri Abhyankar } 17102b4ed282SShri Abhyankar } 17112b4ed282SShri Abhyankar ierr = PetscLogEventEnd(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr); 17122b4ed282SShri Abhyankar PetscFunctionReturn(0); 17132b4ed282SShri Abhyankar } 1714fe835674SShri Abhyankar 1715fe835674SShri Abhyankar /* -------------------------------------------------------------------------- */ 1716fe835674SShri Abhyankar #undef __FUNCT__ 1717fe835674SShri Abhyankar #define __FUNCT__ "SNESLineSearchBoundProjectedCubic_VI" 1718fe835674SShri Abhyankar /* 1719c1a5e521SShri Abhyankar This routine implements a cubic line search while keeping the iterates within bounds 1720fe835674SShri Abhyankar */ 1721fe835674SShri Abhyankar PetscErrorCode SNESLineSearchBoundProjectedCubic_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) 1722fe835674SShri Abhyankar { 1723fe835674SShri Abhyankar PetscReal initslope,lambdaprev,gnormprev,a,b,d,t1,t2,rellength; 1724fe835674SShri Abhyankar PetscReal minlambda,lambda,lambdatemp; 1725fe835674SShri Abhyankar #if defined(PETSC_USE_COMPLEX) 1726fe835674SShri Abhyankar PetscScalar cinitslope; 1727fe835674SShri Abhyankar #endif 1728fe835674SShri Abhyankar PetscErrorCode ierr; 1729fe835674SShri Abhyankar PetscInt count; 1730fe835674SShri Abhyankar SNES_VI *vi = (SNES_VI*)snes->data; 1731fe835674SShri Abhyankar PetscBool changed_w = PETSC_FALSE,changed_y = PETSC_FALSE; 1732fe835674SShri Abhyankar MPI_Comm comm; 1733fe835674SShri Abhyankar 1734fe835674SShri Abhyankar PetscFunctionBegin; 1735fe835674SShri Abhyankar ierr = PetscObjectGetComm((PetscObject)snes,&comm);CHKERRQ(ierr); 1736fe835674SShri Abhyankar ierr = PetscLogEventBegin(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr); 1737fe835674SShri Abhyankar *flag = PETSC_TRUE; 1738fe835674SShri Abhyankar 1739fe835674SShri Abhyankar ierr = VecNorm(y,NORM_2,ynorm);CHKERRQ(ierr); 1740fe835674SShri Abhyankar if (*ynorm == 0.0) { 1741fe835674SShri Abhyankar if (vi->lsmonitor) { 1742fe835674SShri Abhyankar ierr = PetscViewerASCIIMonitorPrintf(vi->lsmonitor," Line search: Initial direction and size is 0\n");CHKERRQ(ierr); 1743fe835674SShri Abhyankar } 1744fe835674SShri Abhyankar *gnorm = fnorm; 1745fe835674SShri Abhyankar ierr = VecCopy(x,w);CHKERRQ(ierr); 1746fe835674SShri Abhyankar ierr = VecCopy(f,g);CHKERRQ(ierr); 1747fe835674SShri Abhyankar *flag = PETSC_FALSE; 1748fe835674SShri Abhyankar goto theend1; 1749fe835674SShri Abhyankar } 1750fe835674SShri Abhyankar if (*ynorm > vi->maxstep) { /* Step too big, so scale back */ 1751fe835674SShri Abhyankar if (vi->lsmonitor) { 1752fe835674SShri Abhyankar ierr = PetscViewerASCIIMonitorPrintf(vi->lsmonitor," Line search: Scaling step by %G old ynorm %G\n",vi->maxstep/(*ynorm),*ynorm);CHKERRQ(ierr); 1753fe835674SShri Abhyankar } 1754fe835674SShri Abhyankar ierr = VecScale(y,vi->maxstep/(*ynorm));CHKERRQ(ierr); 1755fe835674SShri Abhyankar *ynorm = vi->maxstep; 1756fe835674SShri Abhyankar } 1757fe835674SShri Abhyankar ierr = VecMaxPointwiseDivide(y,x,&rellength);CHKERRQ(ierr); 1758fe835674SShri Abhyankar minlambda = vi->minlambda/rellength; 1759fe835674SShri Abhyankar ierr = MatMult(snes->jacobian,y,w);CHKERRQ(ierr); 1760fe835674SShri Abhyankar #if defined(PETSC_USE_COMPLEX) 1761fe835674SShri Abhyankar ierr = VecDot(f,w,&cinitslope);CHKERRQ(ierr); 1762fe835674SShri Abhyankar initslope = PetscRealPart(cinitslope); 1763fe835674SShri Abhyankar #else 1764fe835674SShri Abhyankar ierr = VecDot(f,w,&initslope);CHKERRQ(ierr); 1765fe835674SShri Abhyankar #endif 1766fe835674SShri Abhyankar if (initslope > 0.0) initslope = -initslope; 1767fe835674SShri Abhyankar if (initslope == 0.0) initslope = -1.0; 1768fe835674SShri Abhyankar 1769fe835674SShri Abhyankar ierr = VecWAXPY(w,-1.0,y,x);CHKERRQ(ierr); 1770fe835674SShri Abhyankar ierr = SNESVIProjectOntoBounds(snes,w);CHKERRQ(ierr); 1771fe835674SShri Abhyankar if (snes->nfuncs >= snes->max_funcs) { 1772fe835674SShri Abhyankar ierr = PetscInfo(snes,"Exceeded maximum function evaluations, while checking full step length!\n");CHKERRQ(ierr); 1773fe835674SShri Abhyankar *flag = PETSC_FALSE; 1774fe835674SShri Abhyankar snes->reason = SNES_DIVERGED_FUNCTION_COUNT; 1775fe835674SShri Abhyankar goto theend1; 1776fe835674SShri Abhyankar } 1777fe835674SShri Abhyankar ierr = SNESComputeFunction(snes,w,g);CHKERRQ(ierr); 1778fe835674SShri Abhyankar ierr = SNESVIComputeInactiveSetFnorm(snes,g,w,gnorm);CHKERRQ(ierr); 1779fe835674SShri Abhyankar if (snes->domainerror) { 1780fe835674SShri Abhyankar ierr = PetscLogEventEnd(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr); 1781fe835674SShri Abhyankar PetscFunctionReturn(0); 1782fe835674SShri Abhyankar } 1783fe835674SShri Abhyankar if PetscIsInfOrNanReal(*gnorm) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FP,"User provided compute function generated a Not-a-Number"); 1784fe835674SShri Abhyankar ierr = PetscInfo2(snes,"Initial fnorm %G gnorm %G\n",fnorm,*gnorm);CHKERRQ(ierr); 1785fe835674SShri Abhyankar if (.5*(*gnorm)*(*gnorm) <= .5*fnorm*fnorm + vi->alpha*initslope) { /* Sufficient reduction */ 1786fe835674SShri Abhyankar if (vi->lsmonitor) { 1787fe835674SShri Abhyankar ierr = PetscViewerASCIIMonitorPrintf(vi->lsmonitor," Line search: Using full step: fnorm %G gnorm %G\n",fnorm,*gnorm);CHKERRQ(ierr); 1788fe835674SShri Abhyankar } 1789fe835674SShri Abhyankar goto theend1; 1790fe835674SShri Abhyankar } 1791fe835674SShri Abhyankar 1792fe835674SShri Abhyankar /* Fit points with quadratic */ 1793fe835674SShri Abhyankar lambda = 1.0; 1794fe835674SShri Abhyankar lambdatemp = -initslope/((*gnorm)*(*gnorm) - fnorm*fnorm - 2.0*initslope); 1795fe835674SShri Abhyankar lambdaprev = lambda; 1796fe835674SShri Abhyankar gnormprev = *gnorm; 1797fe835674SShri Abhyankar if (lambdatemp > .5*lambda) lambdatemp = .5*lambda; 1798fe835674SShri Abhyankar if (lambdatemp <= .1*lambda) lambda = .1*lambda; 1799fe835674SShri Abhyankar else lambda = lambdatemp; 1800fe835674SShri Abhyankar 1801fe835674SShri Abhyankar ierr = VecWAXPY(w,-lambda,y,x);CHKERRQ(ierr); 1802fe835674SShri Abhyankar ierr = SNESVIProjectOntoBounds(snes,w);CHKERRQ(ierr); 1803fe835674SShri Abhyankar if (snes->nfuncs >= snes->max_funcs) { 1804fe835674SShri Abhyankar ierr = PetscInfo1(snes,"Exceeded maximum function evaluations, while attempting quadratic backtracking! %D \n",snes->nfuncs);CHKERRQ(ierr); 1805fe835674SShri Abhyankar *flag = PETSC_FALSE; 1806fe835674SShri Abhyankar snes->reason = SNES_DIVERGED_FUNCTION_COUNT; 1807fe835674SShri Abhyankar goto theend1; 1808fe835674SShri Abhyankar } 1809fe835674SShri Abhyankar ierr = SNESComputeFunction(snes,w,g);CHKERRQ(ierr); 1810fe835674SShri Abhyankar ierr = SNESVIComputeInactiveSetFnorm(snes,g,w,gnorm);CHKERRQ(ierr); 1811fe835674SShri Abhyankar if (snes->domainerror) { 1812fe835674SShri Abhyankar ierr = PetscLogEventEnd(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr); 1813fe835674SShri Abhyankar PetscFunctionReturn(0); 1814fe835674SShri Abhyankar } 1815fe835674SShri Abhyankar if PetscIsInfOrNanReal(*gnorm) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FP,"User provided compute function generated a Not-a-Number"); 1816fe835674SShri Abhyankar if (vi->lsmonitor) { 1817fe835674SShri Abhyankar ierr = PetscViewerASCIIMonitorPrintf(vi->lsmonitor," Line search: gnorm after quadratic fit %G\n",*gnorm);CHKERRQ(ierr); 1818fe835674SShri Abhyankar } 1819fe835674SShri Abhyankar if (.5*(*gnorm)*(*gnorm) < .5*fnorm*fnorm + lambda*vi->alpha*initslope) { /* sufficient reduction */ 1820fe835674SShri Abhyankar if (vi->lsmonitor) { 1821fe835674SShri Abhyankar ierr = PetscViewerASCIIMonitorPrintf(vi->lsmonitor," Line search: Quadratically determined step, lambda=%18.16e\n",lambda);CHKERRQ(ierr); 1822fe835674SShri Abhyankar } 1823fe835674SShri Abhyankar goto theend1; 1824fe835674SShri Abhyankar } 1825fe835674SShri Abhyankar 1826fe835674SShri Abhyankar /* Fit points with cubic */ 1827fe835674SShri Abhyankar count = 1; 1828fe835674SShri Abhyankar while (PETSC_TRUE) { 1829fe835674SShri Abhyankar if (lambda <= minlambda) { 1830fe835674SShri Abhyankar if (vi->lsmonitor) { 1831fe835674SShri Abhyankar ierr = PetscViewerASCIIMonitorPrintf(vi->lsmonitor," Line search: unable to find good step length! After %D tries \n",count);CHKERRQ(ierr); 1832fe835674SShri 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); 1833fe835674SShri Abhyankar } 1834fe835674SShri Abhyankar *flag = PETSC_FALSE; 1835fe835674SShri Abhyankar break; 1836fe835674SShri Abhyankar } 1837fe835674SShri Abhyankar t1 = .5*((*gnorm)*(*gnorm) - fnorm*fnorm) - lambda*initslope; 1838fe835674SShri Abhyankar t2 = .5*(gnormprev*gnormprev - fnorm*fnorm) - lambdaprev*initslope; 1839fe835674SShri Abhyankar a = (t1/(lambda*lambda) - t2/(lambdaprev*lambdaprev))/(lambda-lambdaprev); 1840fe835674SShri Abhyankar b = (-lambdaprev*t1/(lambda*lambda) + lambda*t2/(lambdaprev*lambdaprev))/(lambda-lambdaprev); 1841fe835674SShri Abhyankar d = b*b - 3*a*initslope; 1842fe835674SShri Abhyankar if (d < 0.0) d = 0.0; 1843fe835674SShri Abhyankar if (a == 0.0) { 1844fe835674SShri Abhyankar lambdatemp = -initslope/(2.0*b); 1845fe835674SShri Abhyankar } else { 1846fe835674SShri Abhyankar lambdatemp = (-b + sqrt(d))/(3.0*a); 1847fe835674SShri Abhyankar } 1848fe835674SShri Abhyankar lambdaprev = lambda; 1849fe835674SShri Abhyankar gnormprev = *gnorm; 1850fe835674SShri Abhyankar if (lambdatemp > .5*lambda) lambdatemp = .5*lambda; 1851fe835674SShri Abhyankar if (lambdatemp <= .1*lambda) lambda = .1*lambda; 1852fe835674SShri Abhyankar else lambda = lambdatemp; 1853fe835674SShri Abhyankar ierr = VecWAXPY(w,-lambda,y,x);CHKERRQ(ierr); 1854fe835674SShri Abhyankar ierr = SNESVIProjectOntoBounds(snes,w);CHKERRQ(ierr); 1855fe835674SShri Abhyankar if (snes->nfuncs >= snes->max_funcs) { 1856fe835674SShri Abhyankar ierr = PetscInfo1(snes,"Exceeded maximum function evaluations, while looking for good step length! %D \n",count);CHKERRQ(ierr); 1857fe835674SShri 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); 1858fe835674SShri Abhyankar *flag = PETSC_FALSE; 1859fe835674SShri Abhyankar snes->reason = SNES_DIVERGED_FUNCTION_COUNT; 1860fe835674SShri Abhyankar break; 1861fe835674SShri Abhyankar } 1862fe835674SShri Abhyankar ierr = SNESComputeFunction(snes,w,g);CHKERRQ(ierr); 1863fe835674SShri Abhyankar ierr = SNESVIComputeInactiveSetFnorm(snes,g,w,gnorm);CHKERRQ(ierr); 1864fe835674SShri Abhyankar if (snes->domainerror) { 1865fe835674SShri Abhyankar ierr = PetscLogEventEnd(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr); 1866fe835674SShri Abhyankar PetscFunctionReturn(0); 1867fe835674SShri Abhyankar } 1868fe835674SShri Abhyankar if PetscIsInfOrNanReal(*gnorm) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FP,"User provided compute function generated a Not-a-Number"); 1869fe835674SShri Abhyankar if (.5*(*gnorm)*(*gnorm) < .5*fnorm*fnorm + lambda*vi->alpha*initslope) { /* is reduction enough? */ 1870fe835674SShri Abhyankar if (vi->lsmonitor) { 1871fe835674SShri Abhyankar ierr = PetscPrintf(comm," Line search: Cubically determined step, current gnorm %G lambda=%18.16e\n",*gnorm,lambda);CHKERRQ(ierr); 1872fe835674SShri Abhyankar } 1873fe835674SShri Abhyankar break; 1874fe835674SShri Abhyankar } else { 1875fe835674SShri Abhyankar if (vi->lsmonitor) { 1876fe835674SShri Abhyankar ierr = PetscPrintf(comm," Line search: Cubic step no good, shrinking lambda, current gnorm %G lambda=%18.16e\n",*gnorm,lambda);CHKERRQ(ierr); 1877fe835674SShri Abhyankar } 1878fe835674SShri Abhyankar } 1879fe835674SShri Abhyankar count++; 1880fe835674SShri Abhyankar } 1881fe835674SShri Abhyankar theend1: 1882fe835674SShri Abhyankar /* Optional user-defined check for line search step validity */ 1883fe835674SShri Abhyankar if (vi->postcheckstep && *flag) { 1884fe835674SShri Abhyankar ierr = (*vi->postcheckstep)(snes,x,y,w,vi->postcheck,&changed_y,&changed_w);CHKERRQ(ierr); 1885fe835674SShri Abhyankar if (changed_y) { 1886fe835674SShri Abhyankar ierr = VecWAXPY(w,-1.0,y,x);CHKERRQ(ierr); 1887fe835674SShri Abhyankar ierr = SNESVIProjectOntoBounds(snes,w);CHKERRQ(ierr); 1888fe835674SShri Abhyankar } 1889fe835674SShri Abhyankar if (changed_y || changed_w) { /* recompute the function if the step has changed */ 1890fe835674SShri Abhyankar ierr = SNESComputeFunction(snes,w,g);CHKERRQ(ierr); 1891fe835674SShri Abhyankar ierr = SNESVIComputeInactiveSetFnorm(snes,g,w,gnorm);CHKERRQ(ierr); 1892fe835674SShri Abhyankar if (snes->domainerror) { 1893fe835674SShri Abhyankar ierr = PetscLogEventEnd(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr); 1894fe835674SShri Abhyankar PetscFunctionReturn(0); 1895fe835674SShri Abhyankar } 1896fe835674SShri Abhyankar if PetscIsInfOrNanReal(*gnorm) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FP,"User provided compute function generated a Not-a-Number"); 1897fe835674SShri Abhyankar ierr = VecNormBegin(y,NORM_2,ynorm);CHKERRQ(ierr); 1898fe835674SShri Abhyankar ierr = VecNormEnd(y,NORM_2,ynorm);CHKERRQ(ierr); 1899fe835674SShri Abhyankar } 1900fe835674SShri Abhyankar } 1901fe835674SShri Abhyankar ierr = PetscLogEventEnd(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr); 1902fe835674SShri Abhyankar PetscFunctionReturn(0); 1903fe835674SShri Abhyankar } 1904fe835674SShri Abhyankar 19052b4ed282SShri Abhyankar #undef __FUNCT__ 19062b4ed282SShri Abhyankar #define __FUNCT__ "SNESLineSearchQuadratic_VI" 19072b4ed282SShri Abhyankar /* 19082b4ed282SShri Abhyankar This routine is a copy of SNESLineSearchQuadratic in snes/impls/ls/ls.c 19092b4ed282SShri Abhyankar */ 1910ace3abfcSBarry 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) 19112b4ed282SShri Abhyankar { 19122b4ed282SShri Abhyankar /* 19132b4ed282SShri Abhyankar Note that for line search purposes we work with with the related 19142b4ed282SShri Abhyankar minimization problem: 19152b4ed282SShri Abhyankar min z(x): R^n -> R, 19162b4ed282SShri Abhyankar where z(x) = .5 * fnorm*fnorm,and fnorm = || f ||_2. 19172b4ed282SShri Abhyankar z(x) is the same as the merit function for the complementarity problem 19182b4ed282SShri Abhyankar */ 19192b4ed282SShri Abhyankar PetscReal initslope,minlambda,lambda,lambdatemp,rellength; 19202b4ed282SShri Abhyankar #if defined(PETSC_USE_COMPLEX) 19212b4ed282SShri Abhyankar PetscScalar cinitslope; 19222b4ed282SShri Abhyankar #endif 19232b4ed282SShri Abhyankar PetscErrorCode ierr; 19242b4ed282SShri Abhyankar PetscInt count; 19252b4ed282SShri Abhyankar SNES_VI *vi = (SNES_VI*)snes->data; 1926ace3abfcSBarry Smith PetscBool changed_w = PETSC_FALSE,changed_y = PETSC_FALSE; 19272b4ed282SShri Abhyankar 19282b4ed282SShri Abhyankar PetscFunctionBegin; 19292b4ed282SShri Abhyankar ierr = PetscLogEventBegin(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr); 19302b4ed282SShri Abhyankar *flag = PETSC_TRUE; 19312b4ed282SShri Abhyankar 19322b4ed282SShri Abhyankar ierr = VecNorm(y,NORM_2,ynorm);CHKERRQ(ierr); 19332b4ed282SShri Abhyankar if (*ynorm == 0.0) { 1934c92abb8aSShri Abhyankar if (vi->lsmonitor) { 1935c92abb8aSShri Abhyankar ierr = PetscViewerASCIIMonitorPrintf(vi->lsmonitor,"Line search: Direction and size is 0\n");CHKERRQ(ierr); 19362b4ed282SShri Abhyankar } 19372b4ed282SShri Abhyankar *gnorm = fnorm; 19382b4ed282SShri Abhyankar ierr = VecCopy(x,w);CHKERRQ(ierr); 19392b4ed282SShri Abhyankar ierr = VecCopy(f,g);CHKERRQ(ierr); 19402b4ed282SShri Abhyankar *flag = PETSC_FALSE; 19412b4ed282SShri Abhyankar goto theend2; 19422b4ed282SShri Abhyankar } 19432b4ed282SShri Abhyankar if (*ynorm > vi->maxstep) { /* Step too big, so scale back */ 19442b4ed282SShri Abhyankar ierr = VecScale(y,vi->maxstep/(*ynorm));CHKERRQ(ierr); 19452b4ed282SShri Abhyankar *ynorm = vi->maxstep; 19462b4ed282SShri Abhyankar } 19472b4ed282SShri Abhyankar ierr = VecMaxPointwiseDivide(y,x,&rellength);CHKERRQ(ierr); 19482b4ed282SShri Abhyankar minlambda = vi->minlambda/rellength; 19492b4ed282SShri Abhyankar #if defined(PETSC_USE_COMPLEX) 195089d9e806SShri Abhyankar ierr = VecDot(vi->dpsi,y,&cinitslope);CHKERRQ(ierr); 19512b4ed282SShri Abhyankar initslope = PetscRealPart(cinitslope); 19522b4ed282SShri Abhyankar #else 195389d9e806SShri Abhyankar ierr = VecDot(vi->dpsi,y,&initslope);CHKERRQ(ierr); 19542b4ed282SShri Abhyankar #endif 19552b4ed282SShri Abhyankar if (initslope > 0.0) initslope = -initslope; 19562b4ed282SShri Abhyankar if (initslope == 0.0) initslope = -1.0; 19572b4ed282SShri Abhyankar ierr = PetscInfo1(snes,"Initslope %G \n",initslope);CHKERRQ(ierr); 19582b4ed282SShri Abhyankar 19592b4ed282SShri Abhyankar ierr = VecWAXPY(w,-1.0,y,x);CHKERRQ(ierr); 19602b4ed282SShri Abhyankar if (snes->nfuncs >= snes->max_funcs) { 19612b4ed282SShri Abhyankar ierr = PetscInfo(snes,"Exceeded maximum function evaluations, while checking full step length!\n");CHKERRQ(ierr); 19622b4ed282SShri Abhyankar *flag = PETSC_FALSE; 19632b4ed282SShri Abhyankar snes->reason = SNES_DIVERGED_FUNCTION_COUNT; 19642b4ed282SShri Abhyankar goto theend2; 19652b4ed282SShri Abhyankar } 19662b4ed282SShri Abhyankar ierr = SNESComputeFunction(snes,w,g);CHKERRQ(ierr); 19672b4ed282SShri Abhyankar if (snes->domainerror) { 19682b4ed282SShri Abhyankar ierr = PetscLogEventEnd(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr); 19692b4ed282SShri Abhyankar PetscFunctionReturn(0); 19702b4ed282SShri Abhyankar } 19712b4ed282SShri Abhyankar ierr = VecNorm(g,NORM_2,gnorm);CHKERRQ(ierr); 19722b4ed282SShri Abhyankar if PetscIsInfOrNanReal(*gnorm) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FP,"User provided compute function generated a Not-a-Number"); 19732b4ed282SShri Abhyankar if (.5*(*gnorm)*(*gnorm) <= .5*fnorm*fnorm + vi->alpha*initslope) { /* Sufficient reduction */ 1974c92abb8aSShri Abhyankar if (vi->lsmonitor) { 1975c92abb8aSShri Abhyankar ierr = PetscViewerASCIIMonitorPrintf(vi->lsmonitor," Line search: Using full step: fnorm %G gnorm %G\n",fnorm,*gnorm);CHKERRQ(ierr); 19762b4ed282SShri Abhyankar } 19772b4ed282SShri Abhyankar goto theend2; 19782b4ed282SShri Abhyankar } 19792b4ed282SShri Abhyankar 19802b4ed282SShri Abhyankar /* Fit points with quadratic */ 19812b4ed282SShri Abhyankar lambda = 1.0; 19822b4ed282SShri Abhyankar count = 1; 19832b4ed282SShri Abhyankar while (PETSC_TRUE) { 19842b4ed282SShri Abhyankar if (lambda <= minlambda) { /* bad luck; use full step */ 1985c92abb8aSShri Abhyankar if (vi->lsmonitor) { 1986c92abb8aSShri Abhyankar ierr = PetscViewerASCIIMonitorPrintf(vi->lsmonitor,"Line search: Unable to find good step length! %D \n",count);CHKERRQ(ierr); 1987c92abb8aSShri 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); 19882b4ed282SShri Abhyankar } 19892b4ed282SShri Abhyankar ierr = VecCopy(x,w);CHKERRQ(ierr); 19902b4ed282SShri Abhyankar *flag = PETSC_FALSE; 19912b4ed282SShri Abhyankar break; 19922b4ed282SShri Abhyankar } 19932b4ed282SShri Abhyankar lambdatemp = -initslope/((*gnorm)*(*gnorm) - fnorm*fnorm - 2.0*initslope); 19942b4ed282SShri Abhyankar if (lambdatemp > .5*lambda) lambdatemp = .5*lambda; 19952b4ed282SShri Abhyankar if (lambdatemp <= .1*lambda) lambda = .1*lambda; 19962b4ed282SShri Abhyankar else lambda = lambdatemp; 19972b4ed282SShri Abhyankar 19982b4ed282SShri Abhyankar ierr = VecWAXPY(w,-lambda,y,x);CHKERRQ(ierr); 19992b4ed282SShri Abhyankar if (snes->nfuncs >= snes->max_funcs) { 20002b4ed282SShri Abhyankar ierr = PetscInfo1(snes,"Exceeded maximum function evaluations, while looking for good step length! %D \n",count);CHKERRQ(ierr); 20012b4ed282SShri 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); 20022b4ed282SShri Abhyankar *flag = PETSC_FALSE; 20032b4ed282SShri Abhyankar snes->reason = SNES_DIVERGED_FUNCTION_COUNT; 20042b4ed282SShri Abhyankar break; 20052b4ed282SShri Abhyankar } 20062b4ed282SShri Abhyankar ierr = SNESComputeFunction(snes,w,g);CHKERRQ(ierr); 20072b4ed282SShri Abhyankar if (snes->domainerror) { 20082b4ed282SShri Abhyankar ierr = PetscLogEventEnd(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr); 20092b4ed282SShri Abhyankar PetscFunctionReturn(0); 20102b4ed282SShri Abhyankar } 20112b4ed282SShri Abhyankar ierr = VecNorm(g,NORM_2,gnorm);CHKERRQ(ierr); 20122b4ed282SShri Abhyankar if PetscIsInfOrNanReal(*gnorm) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FP,"User provided compute function generated a Not-a-Number"); 20132b4ed282SShri Abhyankar if (.5*(*gnorm)*(*gnorm) < .5*fnorm*fnorm + lambda*vi->alpha*initslope) { /* sufficient reduction */ 2014c92abb8aSShri Abhyankar if (vi->lsmonitor) { 2015c92abb8aSShri Abhyankar ierr = PetscViewerASCIIMonitorPrintf(vi->lsmonitor," Line Search: Quadratically determined step, lambda=%G\n",lambda);CHKERRQ(ierr); 20162b4ed282SShri Abhyankar } 20172b4ed282SShri Abhyankar break; 20182b4ed282SShri Abhyankar } 20192b4ed282SShri Abhyankar count++; 20202b4ed282SShri Abhyankar } 20212b4ed282SShri Abhyankar theend2: 20222b4ed282SShri Abhyankar /* Optional user-defined check for line search step validity */ 20232b4ed282SShri Abhyankar if (vi->postcheckstep) { 20242b4ed282SShri Abhyankar ierr = (*vi->postcheckstep)(snes,x,y,w,vi->postcheck,&changed_y,&changed_w);CHKERRQ(ierr); 20252b4ed282SShri Abhyankar if (changed_y) { 20262b4ed282SShri Abhyankar ierr = VecWAXPY(w,-1.0,y,x);CHKERRQ(ierr); 20272b4ed282SShri Abhyankar } 20282b4ed282SShri Abhyankar if (changed_y || changed_w) { /* recompute the function if the step has changed */ 20292b4ed282SShri Abhyankar ierr = SNESComputeFunction(snes,w,g); 20302b4ed282SShri Abhyankar if (snes->domainerror) { 20312b4ed282SShri Abhyankar ierr = PetscLogEventEnd(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr); 20322b4ed282SShri Abhyankar PetscFunctionReturn(0); 20332b4ed282SShri Abhyankar } 20342b4ed282SShri Abhyankar ierr = VecNormBegin(g,NORM_2,gnorm);CHKERRQ(ierr); 20352b4ed282SShri Abhyankar ierr = VecNormBegin(y,NORM_2,ynorm);CHKERRQ(ierr); 20362b4ed282SShri Abhyankar ierr = VecNormEnd(g,NORM_2,gnorm);CHKERRQ(ierr); 20372b4ed282SShri Abhyankar ierr = VecNormEnd(y,NORM_2,ynorm);CHKERRQ(ierr); 20382b4ed282SShri Abhyankar if PetscIsInfOrNanReal(*gnorm) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FP,"User provided compute function generated a Not-a-Number"); 20392b4ed282SShri Abhyankar } 20402b4ed282SShri Abhyankar } 20412b4ed282SShri Abhyankar ierr = PetscLogEventEnd(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr); 20422b4ed282SShri Abhyankar PetscFunctionReturn(0); 20432b4ed282SShri Abhyankar } 20442b4ed282SShri Abhyankar 2045ace3abfcSBarry 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*/ 20462b4ed282SShri Abhyankar /* -------------------------------------------------------------------------- */ 20472b4ed282SShri Abhyankar EXTERN_C_BEGIN 20482b4ed282SShri Abhyankar #undef __FUNCT__ 20492b4ed282SShri Abhyankar #define __FUNCT__ "SNESLineSearchSet_VI" 20507087cfbeSBarry Smith PetscErrorCode SNESLineSearchSet_VI(SNES snes,FCN2 func,void *lsctx) 20512b4ed282SShri Abhyankar { 20522b4ed282SShri Abhyankar PetscFunctionBegin; 20532b4ed282SShri Abhyankar ((SNES_VI *)(snes->data))->LineSearch = func; 20542b4ed282SShri Abhyankar ((SNES_VI *)(snes->data))->lsP = lsctx; 20552b4ed282SShri Abhyankar PetscFunctionReturn(0); 20562b4ed282SShri Abhyankar } 20572b4ed282SShri Abhyankar EXTERN_C_END 20582b4ed282SShri Abhyankar 20592b4ed282SShri Abhyankar /* -------------------------------------------------------------------------- */ 20602b4ed282SShri Abhyankar EXTERN_C_BEGIN 20612b4ed282SShri Abhyankar #undef __FUNCT__ 20622b4ed282SShri Abhyankar #define __FUNCT__ "SNESLineSearchSetMonitor_VI" 20637087cfbeSBarry Smith PetscErrorCode SNESLineSearchSetMonitor_VI(SNES snes,PetscBool flg) 20642b4ed282SShri Abhyankar { 20652b4ed282SShri Abhyankar SNES_VI *vi = (SNES_VI*)snes->data; 20662b4ed282SShri Abhyankar PetscErrorCode ierr; 20672b4ed282SShri Abhyankar 20682b4ed282SShri Abhyankar PetscFunctionBegin; 2069c92abb8aSShri Abhyankar if (flg && !vi->lsmonitor) { 2070c92abb8aSShri Abhyankar ierr = PetscViewerASCIIMonitorCreate(((PetscObject)snes)->comm,"stdout",((PetscObject)snes)->tablevel,&vi->lsmonitor);CHKERRQ(ierr); 2071c92abb8aSShri Abhyankar } else if (!flg && vi->lsmonitor) { 2072c92abb8aSShri Abhyankar ierr = PetscViewerASCIIMonitorDestroy(vi->lsmonitor);CHKERRQ(ierr); 20732b4ed282SShri Abhyankar } 20742b4ed282SShri Abhyankar PetscFunctionReturn(0); 20752b4ed282SShri Abhyankar } 20762b4ed282SShri Abhyankar EXTERN_C_END 20772b4ed282SShri Abhyankar 20782b4ed282SShri Abhyankar /* 20792b4ed282SShri Abhyankar SNESView_VI - Prints info from the SNESVI data structure. 20802b4ed282SShri Abhyankar 20812b4ed282SShri Abhyankar Input Parameters: 20822b4ed282SShri Abhyankar . SNES - the SNES context 20832b4ed282SShri Abhyankar . viewer - visualization context 20842b4ed282SShri Abhyankar 20852b4ed282SShri Abhyankar Application Interface Routine: SNESView() 20862b4ed282SShri Abhyankar */ 20872b4ed282SShri Abhyankar #undef __FUNCT__ 20882b4ed282SShri Abhyankar #define __FUNCT__ "SNESView_VI" 20892b4ed282SShri Abhyankar static PetscErrorCode SNESView_VI(SNES snes,PetscViewer viewer) 20902b4ed282SShri Abhyankar { 20912b4ed282SShri Abhyankar SNES_VI *vi = (SNES_VI *)snes->data; 209278c4b9d3SShri Abhyankar const char *cstr,*tstr; 20932b4ed282SShri Abhyankar PetscErrorCode ierr; 2094ace3abfcSBarry Smith PetscBool iascii; 20952b4ed282SShri Abhyankar 20962b4ed282SShri Abhyankar PetscFunctionBegin; 20972b4ed282SShri Abhyankar ierr = PetscTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr); 20982b4ed282SShri Abhyankar if (iascii) { 20992b4ed282SShri Abhyankar if (vi->LineSearch == SNESLineSearchNo_VI) cstr = "SNESLineSearchNo"; 21002b4ed282SShri Abhyankar else if (vi->LineSearch == SNESLineSearchQuadratic_VI) cstr = "SNESLineSearchQuadratic"; 21012b4ed282SShri Abhyankar else if (vi->LineSearch == SNESLineSearchCubic_VI) cstr = "SNESLineSearchCubic"; 2102fe835674SShri Abhyankar else if (vi->LineSearch == SNESLineSearchBoundProjectedCubic_VI) cstr = "SNESLineSearchBoundProjectedCubic"; 2103c1a5e521SShri Abhyankar else if(vi->LineSearch == SNESLineSearchBoundProjectedNo_VI) cstr = "SNESLineSearchBoundProjectedBasic"; 21042b4ed282SShri Abhyankar else cstr = "unknown"; 210578c4b9d3SShri Abhyankar if (snes->ops->solve == SNESSolveVI_SS) tstr = "Semismooth"; 210678c4b9d3SShri Abhyankar else if (snes->ops->solve == SNESSolveVI_AS) tstr = "Active Set"; 21070a7c7af0SShri Abhyankar else if (snes->ops->solve == SNESSolveVI_RS) tstr = "Reduced Space"; 210878c4b9d3SShri Abhyankar else tstr = "unknown"; 210978c4b9d3SShri Abhyankar ierr = PetscViewerASCIIPrintf(viewer," VI algorithm: %s\n",tstr);CHKERRQ(ierr); 21102b4ed282SShri Abhyankar ierr = PetscViewerASCIIPrintf(viewer," line search variant: %s\n",cstr);CHKERRQ(ierr); 21112b4ed282SShri Abhyankar ierr = PetscViewerASCIIPrintf(viewer," alpha=%G, maxstep=%G, minlambda=%G\n",vi->alpha,vi->maxstep,vi->minlambda);CHKERRQ(ierr); 21122b4ed282SShri Abhyankar } else { 21132b4ed282SShri Abhyankar SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Viewer type %s not supported for SNES EQ VI",((PetscObject)viewer)->type_name); 21142b4ed282SShri Abhyankar } 21152b4ed282SShri Abhyankar PetscFunctionReturn(0); 21162b4ed282SShri Abhyankar } 21172b4ed282SShri Abhyankar 21182b4ed282SShri Abhyankar /* 21192b4ed282SShri Abhyankar SNESVISetVariableBounds - Sets the lower and upper bounds for the solution vector. xl <= x <= xu. 21202b4ed282SShri Abhyankar 21212b4ed282SShri Abhyankar Input Parameters: 21222b4ed282SShri Abhyankar . snes - the SNES context. 21232b4ed282SShri Abhyankar . xl - lower bound. 21242b4ed282SShri Abhyankar . xu - upper bound. 21252b4ed282SShri Abhyankar 21262b4ed282SShri Abhyankar Notes: 21272b4ed282SShri Abhyankar If this routine is not called then the lower and upper bounds are set to 212884c105d7SBarry Smith PETSC_VI_INF and PETSC_VI_NINF respectively during SNESSetUp(). 212984c105d7SBarry Smith 21302b4ed282SShri Abhyankar */ 21312b4ed282SShri Abhyankar 21322b4ed282SShri Abhyankar #undef __FUNCT__ 21332b4ed282SShri Abhyankar #define __FUNCT__ "SNESVISetVariableBounds" 213469c03620SShri Abhyankar PetscErrorCode SNESVISetVariableBounds(SNES snes, Vec xl, Vec xu) 21352b4ed282SShri Abhyankar { 21362b4ed282SShri Abhyankar SNES_VI *vi = (SNES_VI*)snes->data; 21372b4ed282SShri Abhyankar 21382b4ed282SShri Abhyankar PetscFunctionBegin; 21392b4ed282SShri Abhyankar PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 21402b4ed282SShri Abhyankar PetscValidHeaderSpecific(xl,VEC_CLASSID,2); 21412b4ed282SShri Abhyankar PetscValidHeaderSpecific(xu,VEC_CLASSID,3); 21422b4ed282SShri Abhyankar 21432b4ed282SShri Abhyankar /* Check if SNESSetFunction is called */ 21442b4ed282SShri Abhyankar if(!snes->vec_func) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call SNESSetFunction() first"); 21452b4ed282SShri Abhyankar 21462b4ed282SShri Abhyankar /* Check if the vector sizes are compatible for lower and upper bounds */ 21472b4ed282SShri 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); 21482b4ed282SShri 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); 21492b4ed282SShri Abhyankar vi->usersetxbounds = PETSC_TRUE; 21502b4ed282SShri Abhyankar vi->xl = xl; 21512b4ed282SShri Abhyankar vi->xu = xu; 21522b4ed282SShri Abhyankar 21532b4ed282SShri Abhyankar PetscFunctionReturn(0); 21542b4ed282SShri Abhyankar } 21552b4ed282SShri Abhyankar /* -------------------------------------------------------------------------- */ 21562b4ed282SShri Abhyankar /* 21572b4ed282SShri Abhyankar SNESSetFromOptions_VI - Sets various parameters for the SNESVI method. 21582b4ed282SShri Abhyankar 21592b4ed282SShri Abhyankar Input Parameter: 21602b4ed282SShri Abhyankar . snes - the SNES context 21612b4ed282SShri Abhyankar 21622b4ed282SShri Abhyankar Application Interface Routine: SNESSetFromOptions() 21632b4ed282SShri Abhyankar */ 21642b4ed282SShri Abhyankar #undef __FUNCT__ 21652b4ed282SShri Abhyankar #define __FUNCT__ "SNESSetFromOptions_VI" 21662b4ed282SShri Abhyankar static PetscErrorCode SNESSetFromOptions_VI(SNES snes) 21672b4ed282SShri Abhyankar { 21682b4ed282SShri Abhyankar SNES_VI *vi = (SNES_VI *)snes->data; 2169c1a5e521SShri Abhyankar const char *lses[] = {"basic","basicnonorms","quadratic","cubic","boundproj_basic"}; 2170d950fb63SShri Abhyankar const char *vies[] = {"ss","as","rs"}; 21712b4ed282SShri Abhyankar PetscErrorCode ierr; 21722b4ed282SShri Abhyankar PetscInt indx; 217369c03620SShri Abhyankar PetscBool flg,set,flg2; 21742b4ed282SShri Abhyankar 21752b4ed282SShri Abhyankar PetscFunctionBegin; 21762b4ed282SShri Abhyankar ierr = PetscOptionsHead("SNES semismooth method options");CHKERRQ(ierr); 21779308c137SBarry Smith ierr = PetscOptionsBool("-snes_vi_monitor","Monitor all non-active variables","None",PETSC_FALSE,&flg,0);CHKERRQ(ierr); 21789308c137SBarry Smith if (flg) { 21799308c137SBarry Smith ierr = SNESMonitorSet(snes,SNESMonitorVI,0,0);CHKERRQ(ierr); 21809308c137SBarry Smith } 21812b4ed282SShri Abhyankar ierr = PetscOptionsReal("-snes_vi_alpha","Function norm must decrease by","None",vi->alpha,&vi->alpha,0);CHKERRQ(ierr); 21822b4ed282SShri Abhyankar ierr = PetscOptionsReal("-snes_vi_maxstep","Step must be less than","None",vi->maxstep,&vi->maxstep,0);CHKERRQ(ierr); 21832b4ed282SShri Abhyankar ierr = PetscOptionsReal("-snes_vi_minlambda","Minimum lambda allowed","None",vi->minlambda,&vi->minlambda,0);CHKERRQ(ierr); 21842b4ed282SShri Abhyankar ierr = PetscOptionsReal("-snes_vi_const_tol","constraint tolerance","None",vi->const_tol,&vi->const_tol,0);CHKERRQ(ierr); 2185acfcf0e5SJed Brown ierr = PetscOptionsBool("-snes_vi_lsmonitor","Print progress of line searches","SNESLineSearchSetMonitor",vi->lsmonitor ? PETSC_TRUE : PETSC_FALSE,&flg,&set);CHKERRQ(ierr); 21862b4ed282SShri Abhyankar if (set) {ierr = SNESLineSearchSetMonitor(snes,flg);CHKERRQ(ierr);} 2187d950fb63SShri Abhyankar ierr = PetscOptionsEList("-snes_vi_type","Semismooth algorithm used","",vies,3,"ss",&indx,&flg2);CHKERRQ(ierr); 218869c03620SShri Abhyankar if (flg2) { 218969c03620SShri Abhyankar switch (indx) { 219069c03620SShri Abhyankar case 0: 219169c03620SShri Abhyankar snes->ops->solve = SNESSolveVI_SS; 219269c03620SShri Abhyankar break; 219369c03620SShri Abhyankar case 1: 219469c03620SShri Abhyankar snes->ops->solve = SNESSolveVI_AS; 219569c03620SShri Abhyankar break; 2196d950fb63SShri Abhyankar case 2: 2197d950fb63SShri Abhyankar snes->ops->solve = SNESSolveVI_RS; 2198d950fb63SShri Abhyankar break; 219969c03620SShri Abhyankar } 220069c03620SShri Abhyankar } 2201fe835674SShri Abhyankar if (snes->ops->solve == SNESSolveVI_RS) { 2202fe835674SShri Abhyankar ierr = SNESLineSearchSet(snes,SNESLineSearchBoundProjectedCubic_VI,PETSC_NULL);CHKERRQ(ierr); 2203fe835674SShri Abhyankar } 2204fe835674SShri Abhyankar else { 2205c1a5e521SShri Abhyankar ierr = PetscOptionsEList("-snes_vi_ls","Line search used","SNESLineSearchSet",lses,5,"boundproj_basic",&indx,&flg);CHKERRQ(ierr); 22062b4ed282SShri Abhyankar if (flg) { 22072b4ed282SShri Abhyankar switch (indx) { 22082b4ed282SShri Abhyankar case 0: 22092b4ed282SShri Abhyankar ierr = SNESLineSearchSet(snes,SNESLineSearchNo_VI,PETSC_NULL);CHKERRQ(ierr); 22102b4ed282SShri Abhyankar break; 22112b4ed282SShri Abhyankar case 1: 22122b4ed282SShri Abhyankar ierr = SNESLineSearchSet(snes,SNESLineSearchNoNorms_VI,PETSC_NULL);CHKERRQ(ierr); 22132b4ed282SShri Abhyankar break; 22142b4ed282SShri Abhyankar case 2: 22152b4ed282SShri Abhyankar ierr = SNESLineSearchSet(snes,SNESLineSearchQuadratic_VI,PETSC_NULL);CHKERRQ(ierr); 22162b4ed282SShri Abhyankar break; 22172b4ed282SShri Abhyankar case 3: 22182b4ed282SShri Abhyankar ierr = SNESLineSearchSet(snes,SNESLineSearchCubic_VI,PETSC_NULL);CHKERRQ(ierr); 22192b4ed282SShri Abhyankar break; 2220c1a5e521SShri Abhyankar case 4: 2221c1a5e521SShri Abhyankar ierr = SNESLineSearchSet(snes,SNESLineSearchBoundProjectedNo_VI,PETSC_NULL);CHKERRQ(ierr); 2222c1a5e521SShri Abhyankar break; 22232b4ed282SShri Abhyankar } 22242b4ed282SShri Abhyankar } 2225fe835674SShri Abhyankar } 22262b4ed282SShri Abhyankar ierr = PetscOptionsTail();CHKERRQ(ierr); 22272b4ed282SShri Abhyankar PetscFunctionReturn(0); 22282b4ed282SShri Abhyankar } 22292b4ed282SShri Abhyankar /* -------------------------------------------------------------------------- */ 22302b4ed282SShri Abhyankar /*MC 22312b4ed282SShri Abhyankar SNESVI - Semismooth newton method based nonlinear solver that uses a line search 22322b4ed282SShri Abhyankar 22332b4ed282SShri Abhyankar Options Database: 22342b4ed282SShri Abhyankar + -snes_vi [cubic,quadratic,basic,basicnonorms] - Selects line search 22352b4ed282SShri Abhyankar . -snes_vi_alpha <alpha> - Sets alpha 22362b4ed282SShri Abhyankar . -snes_vi_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) 22372b4ed282SShri Abhyankar . -snes_vi_minlambda <minlambda> - Sets the minimum lambda the line search will use minlambda / max_i ( y[i]/x[i] ) 22382b4ed282SShri Abhyankar - -snes_vi_monitor - print information about progress of line searches 22392b4ed282SShri Abhyankar 22402b4ed282SShri Abhyankar 22412b4ed282SShri Abhyankar Level: beginner 22422b4ed282SShri Abhyankar 22432b4ed282SShri Abhyankar .seealso: SNESCreate(), SNES, SNESSetType(), SNESTR, SNESLineSearchSet(), 22442b4ed282SShri Abhyankar SNESLineSearchSetPostCheck(), SNESLineSearchNo(), SNESLineSearchCubic(), SNESLineSearchQuadratic(), 22452b4ed282SShri Abhyankar SNESLineSearchSet(), SNESLineSearchNoNorms(), SNESLineSearchSetPreCheck(), SNESLineSearchSetParams(), SNESLineSearchGetParams() 22462b4ed282SShri Abhyankar 22472b4ed282SShri Abhyankar M*/ 22482b4ed282SShri Abhyankar EXTERN_C_BEGIN 22492b4ed282SShri Abhyankar #undef __FUNCT__ 22502b4ed282SShri Abhyankar #define __FUNCT__ "SNESCreate_VI" 22517087cfbeSBarry Smith PetscErrorCode SNESCreate_VI(SNES snes) 22522b4ed282SShri Abhyankar { 22532b4ed282SShri Abhyankar PetscErrorCode ierr; 22542b4ed282SShri Abhyankar SNES_VI *vi; 22552b4ed282SShri Abhyankar 22562b4ed282SShri Abhyankar PetscFunctionBegin; 22572b4ed282SShri Abhyankar snes->ops->setup = SNESSetUp_VI; 225869c03620SShri Abhyankar snes->ops->solve = SNESSolveVI_SS; 22592b4ed282SShri Abhyankar snes->ops->destroy = SNESDestroy_VI; 22602b4ed282SShri Abhyankar snes->ops->setfromoptions = SNESSetFromOptions_VI; 22612b4ed282SShri Abhyankar snes->ops->view = SNESView_VI; 22622b4ed282SShri Abhyankar snes->ops->converged = SNESDefaultConverged_VI; 22632b4ed282SShri Abhyankar 22642b4ed282SShri Abhyankar ierr = PetscNewLog(snes,SNES_VI,&vi);CHKERRQ(ierr); 22652b4ed282SShri Abhyankar snes->data = (void*)vi; 22662b4ed282SShri Abhyankar vi->alpha = 1.e-4; 22672b4ed282SShri Abhyankar vi->maxstep = 1.e8; 22682b4ed282SShri Abhyankar vi->minlambda = 1.e-12; 2269c1a5e521SShri Abhyankar vi->LineSearch = SNESLineSearchBoundProjectedNo_VI; 22702b4ed282SShri Abhyankar vi->lsP = PETSC_NULL; 22712b4ed282SShri Abhyankar vi->postcheckstep = PETSC_NULL; 22722b4ed282SShri Abhyankar vi->postcheck = PETSC_NULL; 22732b4ed282SShri Abhyankar vi->precheckstep = PETSC_NULL; 22742b4ed282SShri Abhyankar vi->precheck = PETSC_NULL; 22752b4ed282SShri Abhyankar vi->const_tol = 2.2204460492503131e-16; 22762b4ed282SShri Abhyankar vi->computessfunction = ComputeFischerFunction; 22772b4ed282SShri Abhyankar 22782b4ed282SShri Abhyankar ierr = PetscObjectComposeFunctionDynamic((PetscObject)snes,"SNESLineSearchSetMonitor_C","SNESLineSearchSetMonitor_VI",SNESLineSearchSetMonitor_VI);CHKERRQ(ierr); 22792b4ed282SShri Abhyankar ierr = PetscObjectComposeFunctionDynamic((PetscObject)snes,"SNESLineSearchSet_C","SNESLineSearchSet_VI",SNESLineSearchSet_VI);CHKERRQ(ierr); 22802b4ed282SShri Abhyankar 22812b4ed282SShri Abhyankar PetscFunctionReturn(0); 22822b4ed282SShri Abhyankar } 22832b4ed282SShri Abhyankar EXTERN_C_END 2284