xref: /petsc/src/snes/impls/vi/vi.c (revision 3f731af576bb83cafc3f2f97c96aa218566f9535)
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"
89308c137SBarry Smith PetscErrorCode PETSCSNES_DLLEXPORT 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;
149308c137SBarry Smith   PetscInt                i,n;
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);
25*3f731af5SBarry Smith   ierr = VecGetArrayRead(snes->vec_func,&f);CHKERRQ(ierr);
269308c137SBarry Smith 
279308c137SBarry Smith   rnorm = 0.0;
289308c137SBarry Smith   for (i=0; i<n; i++) {
2927c67122SBarry Smith     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];
309308c137SBarry Smith   }
31*3f731af5SBarry Smith   ierr = VecRestoreArrayRead(snes->vec_func,&f);CHKERRQ(ierr);
329308c137SBarry Smith   ierr = VecRestoreArrayRead(vi->xl,&xl);CHKERRQ(ierr);
339308c137SBarry Smith   ierr = VecRestoreArrayRead(vi->xu,&xu);CHKERRQ(ierr);
349308c137SBarry Smith   ierr = VecRestoreArrayRead(snes->vec_sol,&x);CHKERRQ(ierr);
359308c137SBarry Smith   ierr = MPI_Allreduce(&rnorm,&fnorm,1,MPIU_REAL,MPI_SUM,((PetscObject)snes)->comm);CHKERRQ(ierr);
369308c137SBarry Smith   fnorm = sqrt(fnorm);
379308c137SBarry Smith   ierr = PetscViewerASCIIMonitorPrintf(viewer,"%3D SNES VI Function norm %14.12e \n",its,fnorm);CHKERRQ(ierr);
389308c137SBarry Smith   if (!dummy) {
399308c137SBarry Smith     ierr = PetscViewerASCIIMonitorDestroy(viewer);CHKERRQ(ierr);
409308c137SBarry Smith   }
419308c137SBarry Smith   PetscFunctionReturn(0);
429308c137SBarry Smith }
439308c137SBarry Smith 
442b4ed282SShri Abhyankar /*
452b4ed282SShri Abhyankar      Checks if J^T F = 0 which implies we've found a local minimum of the norm of the function,
462b4ed282SShri 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
472b4ed282SShri Abhyankar     0 = (J^T F)^T W = F^T J W iff W not in the null space of J. Thanks for Jorge More
482b4ed282SShri Abhyankar     for this trick. One assumes that the probability that W is in the null space of J is very, very small.
492b4ed282SShri Abhyankar */
502b4ed282SShri Abhyankar #undef __FUNCT__
512b4ed282SShri Abhyankar #define __FUNCT__ "SNESVICheckLocalMin_Private"
52ace3abfcSBarry Smith PetscErrorCode SNESVICheckLocalMin_Private(SNES snes,Mat A,Vec F,Vec W,PetscReal fnorm,PetscBool *ismin)
532b4ed282SShri Abhyankar {
542b4ed282SShri Abhyankar   PetscReal      a1;
552b4ed282SShri Abhyankar   PetscErrorCode ierr;
56ace3abfcSBarry Smith   PetscBool     hastranspose;
572b4ed282SShri Abhyankar 
582b4ed282SShri Abhyankar   PetscFunctionBegin;
592b4ed282SShri Abhyankar   *ismin = PETSC_FALSE;
602b4ed282SShri Abhyankar   ierr = MatHasOperation(A,MATOP_MULT_TRANSPOSE,&hastranspose);CHKERRQ(ierr);
612b4ed282SShri Abhyankar   if (hastranspose) {
622b4ed282SShri Abhyankar     /* Compute || J^T F|| */
632b4ed282SShri Abhyankar     ierr = MatMultTranspose(A,F,W);CHKERRQ(ierr);
642b4ed282SShri Abhyankar     ierr = VecNorm(W,NORM_2,&a1);CHKERRQ(ierr);
652b4ed282SShri Abhyankar     ierr = PetscInfo1(snes,"|| J^T F|| %G near zero implies found a local minimum\n",a1/fnorm);CHKERRQ(ierr);
662b4ed282SShri Abhyankar     if (a1/fnorm < 1.e-4) *ismin = PETSC_TRUE;
672b4ed282SShri Abhyankar   } else {
682b4ed282SShri Abhyankar     Vec         work;
692b4ed282SShri Abhyankar     PetscScalar result;
702b4ed282SShri Abhyankar     PetscReal   wnorm;
712b4ed282SShri Abhyankar 
722b4ed282SShri Abhyankar     ierr = VecSetRandom(W,PETSC_NULL);CHKERRQ(ierr);
732b4ed282SShri Abhyankar     ierr = VecNorm(W,NORM_2,&wnorm);CHKERRQ(ierr);
742b4ed282SShri Abhyankar     ierr = VecDuplicate(W,&work);CHKERRQ(ierr);
752b4ed282SShri Abhyankar     ierr = MatMult(A,W,work);CHKERRQ(ierr);
762b4ed282SShri Abhyankar     ierr = VecDot(F,work,&result);CHKERRQ(ierr);
772b4ed282SShri Abhyankar     ierr = VecDestroy(work);CHKERRQ(ierr);
782b4ed282SShri Abhyankar     a1   = PetscAbsScalar(result)/(fnorm*wnorm);
792b4ed282SShri Abhyankar     ierr = PetscInfo1(snes,"(F^T J random)/(|| F ||*||random|| %G near zero implies found a local minimum\n",a1);CHKERRQ(ierr);
802b4ed282SShri Abhyankar     if (a1 < 1.e-4) *ismin = PETSC_TRUE;
812b4ed282SShri Abhyankar   }
822b4ed282SShri Abhyankar   PetscFunctionReturn(0);
832b4ed282SShri Abhyankar }
842b4ed282SShri Abhyankar 
852b4ed282SShri Abhyankar /*
862b4ed282SShri Abhyankar      Checks if J^T(F - J*X) = 0
872b4ed282SShri Abhyankar */
882b4ed282SShri Abhyankar #undef __FUNCT__
892b4ed282SShri Abhyankar #define __FUNCT__ "SNESVICheckResidual_Private"
902b4ed282SShri Abhyankar PetscErrorCode SNESVICheckResidual_Private(SNES snes,Mat A,Vec F,Vec X,Vec W1,Vec W2)
912b4ed282SShri Abhyankar {
922b4ed282SShri Abhyankar   PetscReal      a1,a2;
932b4ed282SShri Abhyankar   PetscErrorCode ierr;
94ace3abfcSBarry Smith   PetscBool     hastranspose;
952b4ed282SShri Abhyankar 
962b4ed282SShri Abhyankar   PetscFunctionBegin;
972b4ed282SShri Abhyankar   ierr = MatHasOperation(A,MATOP_MULT_TRANSPOSE,&hastranspose);CHKERRQ(ierr);
982b4ed282SShri Abhyankar   if (hastranspose) {
992b4ed282SShri Abhyankar     ierr = MatMult(A,X,W1);CHKERRQ(ierr);
1002b4ed282SShri Abhyankar     ierr = VecAXPY(W1,-1.0,F);CHKERRQ(ierr);
1012b4ed282SShri Abhyankar 
1022b4ed282SShri Abhyankar     /* Compute || J^T W|| */
1032b4ed282SShri Abhyankar     ierr = MatMultTranspose(A,W1,W2);CHKERRQ(ierr);
1042b4ed282SShri Abhyankar     ierr = VecNorm(W1,NORM_2,&a1);CHKERRQ(ierr);
1052b4ed282SShri Abhyankar     ierr = VecNorm(W2,NORM_2,&a2);CHKERRQ(ierr);
1062b4ed282SShri Abhyankar     if (a1 != 0.0) {
1072b4ed282SShri Abhyankar       ierr = PetscInfo1(snes,"||J^T(F-Ax)||/||F-AX|| %G near zero implies inconsistent rhs\n",a2/a1);CHKERRQ(ierr);
1082b4ed282SShri Abhyankar     }
1092b4ed282SShri Abhyankar   }
1102b4ed282SShri Abhyankar   PetscFunctionReturn(0);
1112b4ed282SShri Abhyankar }
1122b4ed282SShri Abhyankar 
1132b4ed282SShri Abhyankar /*
1142b4ed282SShri Abhyankar   SNESDefaultConverged_VI - Checks the convergence of the semismooth newton algorithm.
1152b4ed282SShri Abhyankar 
1162b4ed282SShri Abhyankar   Notes:
1172b4ed282SShri Abhyankar   The convergence criterion currently implemented is
1182b4ed282SShri Abhyankar   merit < abstol
1192b4ed282SShri Abhyankar   merit < rtol*merit_initial
1202b4ed282SShri Abhyankar */
1212b4ed282SShri Abhyankar #undef __FUNCT__
1222b4ed282SShri Abhyankar #define __FUNCT__ "SNESDefaultConverged_VI"
1232b4ed282SShri Abhyankar PetscErrorCode SNESDefaultConverged_VI(SNES snes,PetscInt it,PetscReal xnorm,PetscReal gradnorm,PetscReal merit,SNESConvergedReason *reason,void *dummy)
1242b4ed282SShri Abhyankar {
1252b4ed282SShri Abhyankar   PetscErrorCode ierr;
1262b4ed282SShri Abhyankar 
1272b4ed282SShri Abhyankar   PetscFunctionBegin;
1282b4ed282SShri Abhyankar   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
1292b4ed282SShri Abhyankar   PetscValidPointer(reason,6);
1302b4ed282SShri Abhyankar 
1312b4ed282SShri Abhyankar   *reason = SNES_CONVERGED_ITERATING;
1322b4ed282SShri Abhyankar 
1332b4ed282SShri Abhyankar   if (!it) {
1342b4ed282SShri Abhyankar     /* set parameter for default relative tolerance convergence test */
1352b4ed282SShri Abhyankar     snes->ttol = merit*snes->rtol;
1362b4ed282SShri Abhyankar   }
1372b4ed282SShri Abhyankar   if (merit != merit) {
1382b4ed282SShri Abhyankar     ierr = PetscInfo(snes,"Failed to converged, function norm is NaN\n");CHKERRQ(ierr);
1392b4ed282SShri Abhyankar     *reason = SNES_DIVERGED_FNORM_NAN;
1402b4ed282SShri Abhyankar   } else if (merit < snes->abstol) {
1412b4ed282SShri Abhyankar     ierr = PetscInfo2(snes,"Converged due to merit function %G < %G\n",merit,snes->abstol);CHKERRQ(ierr);
1422b4ed282SShri Abhyankar     *reason = SNES_CONVERGED_FNORM_ABS;
1432b4ed282SShri Abhyankar   } else if (snes->nfuncs >= snes->max_funcs) {
1442b4ed282SShri Abhyankar     ierr = PetscInfo2(snes,"Exceeded maximum number of function evaluations: %D > %D\n",snes->nfuncs,snes->max_funcs);CHKERRQ(ierr);
1452b4ed282SShri Abhyankar     *reason = SNES_DIVERGED_FUNCTION_COUNT;
1462b4ed282SShri Abhyankar   }
1472b4ed282SShri Abhyankar 
1482b4ed282SShri Abhyankar   if (it && !*reason) {
1492b4ed282SShri Abhyankar     if (merit < snes->ttol) {
1502b4ed282SShri Abhyankar       ierr = PetscInfo2(snes,"Converged due to merit function %G < %G (relative tolerance)\n",merit,snes->ttol);CHKERRQ(ierr);
1512b4ed282SShri Abhyankar       *reason = SNES_CONVERGED_FNORM_RELATIVE;
1522b4ed282SShri Abhyankar     }
1532b4ed282SShri Abhyankar   }
1542b4ed282SShri Abhyankar   PetscFunctionReturn(0);
1552b4ed282SShri Abhyankar }
1562b4ed282SShri Abhyankar 
1572b4ed282SShri Abhyankar /*
1582b4ed282SShri Abhyankar   SNESVIComputeMeritFunction - Evaluates the merit function for the mixed complementarity problem.
1592b4ed282SShri Abhyankar 
1602b4ed282SShri Abhyankar   Input Parameter:
1612b4ed282SShri Abhyankar . phi - the semismooth function
1622b4ed282SShri Abhyankar 
1632b4ed282SShri Abhyankar   Output Parameter:
1642b4ed282SShri Abhyankar . merit - the merit function
1652b4ed282SShri Abhyankar . phinorm - ||phi||
1662b4ed282SShri Abhyankar 
1672b4ed282SShri Abhyankar   Notes:
1682b4ed282SShri Abhyankar   The merit function for the mixed complementarity problem is defined as
1692b4ed282SShri Abhyankar      merit = 0.5*phi^T*phi
1702b4ed282SShri Abhyankar */
1712b4ed282SShri Abhyankar #undef __FUNCT__
1722b4ed282SShri Abhyankar #define __FUNCT__ "SNESVIComputeMeritFunction"
1732b4ed282SShri Abhyankar static PetscErrorCode SNESVIComputeMeritFunction(Vec phi, PetscReal* merit,PetscReal* phinorm)
1742b4ed282SShri Abhyankar {
1752b4ed282SShri Abhyankar   PetscErrorCode ierr;
1762b4ed282SShri Abhyankar 
1772b4ed282SShri Abhyankar   PetscFunctionBegin;
1782b4ed282SShri Abhyankar   ierr = VecNormBegin(phi,NORM_2,phinorm);
1792b4ed282SShri Abhyankar   ierr = VecNormEnd(phi,NORM_2,phinorm);
1802b4ed282SShri Abhyankar 
1812b4ed282SShri Abhyankar   *merit = 0.5*(*phinorm)*(*phinorm);
1822b4ed282SShri Abhyankar   PetscFunctionReturn(0);
1832b4ed282SShri Abhyankar }
1842b4ed282SShri Abhyankar 
1852b4ed282SShri Abhyankar /*
1862b4ed282SShri Abhyankar   ComputeFischerFunction - Computes the semismooth fischer burmeister function for a mixed complementarity equation.
1872b4ed282SShri Abhyankar 
1882b4ed282SShri Abhyankar   Notes:
1892b4ed282SShri Abhyankar   The Fischer-Burmeister function is defined as
1902b4ed282SShri Abhyankar        ff(a,b) := sqrt(a*a + b*b) - a - b
1912b4ed282SShri Abhyankar   and is used reformulate a complementarity equation  as a semismooth equation.
1922b4ed282SShri Abhyankar */
1932b4ed282SShri Abhyankar 
1942b4ed282SShri Abhyankar #undef __FUNCT__
1952b4ed282SShri Abhyankar #define __FUNCT__ "ComputeFischerFunction"
1962b4ed282SShri Abhyankar static PetscErrorCode ComputeFischerFunction(PetscScalar a, PetscScalar b, PetscScalar* ff)
1972b4ed282SShri Abhyankar {
1982b4ed282SShri Abhyankar   PetscFunctionBegin;
1992b4ed282SShri Abhyankar   *ff = sqrt(a*a + b*b) - a - b;
2002b4ed282SShri Abhyankar   PetscFunctionReturn(0);
2012b4ed282SShri Abhyankar }
2022b4ed282SShri Abhyankar 
2032b4ed282SShri Abhyankar /*
2041f79c099SShri Abhyankar    SNESVIComputeFunction - Reformulates a system of nonlinear equations in mixed complementarity form to a system of nonlinear equations in semismooth form.
2052b4ed282SShri Abhyankar 
2062b4ed282SShri Abhyankar    Input Parameters:
2072b4ed282SShri Abhyankar .  snes - the SNES context
2082b4ed282SShri Abhyankar .  x - current iterate
2092b4ed282SShri Abhyankar .  functx - user defined function context
2102b4ed282SShri Abhyankar 
2112b4ed282SShri Abhyankar    Output Parameters:
2122b4ed282SShri Abhyankar .  phi - Semismooth function
2132b4ed282SShri Abhyankar 
2142b4ed282SShri Abhyankar    Notes:
2152b4ed282SShri Abhyankar    The result of this function is done by cases:
2162b4ed282SShri Abhyankar +  l[i] == -infinity, u[i] == infinity  -- phi[i] = -f[i]
2172b4ed282SShri Abhyankar .  l[i] == -infinity, u[i] finite       -- phi[i] = ss(u[i]-x[i], -f[i])
2182b4ed282SShri Abhyankar .  l[i] finite,       u[i] == infinity  -- phi[i] = ss(x[i]-l[i],  f[i])
2192b4ed282SShri Abhyankar .  l[i] finite < u[i] finite -- phi[i] = phi(x[i]-l[i], ss(u[i]-x[i], -f[u]))
2202b4ed282SShri Abhyankar -  otherwise l[i] == u[i] -- phi[i] = l[i] - x[i]
2212b4ed282SShri Abhyankar    ss is the semismoothing function used to reformulate the nonlinear equation in complementarity
2222b4ed282SShri Abhyankar    form to semismooth form
2232b4ed282SShri Abhyankar 
2242b4ed282SShri Abhyankar */
2252b4ed282SShri Abhyankar #undef __FUNCT__
2261f79c099SShri Abhyankar #define __FUNCT__ "SNESVIComputeFunction"
2271f79c099SShri Abhyankar static PetscErrorCode SNESVIComputeFunction(SNES snes,Vec X,Vec phi,void* functx)
2282b4ed282SShri Abhyankar {
2292b4ed282SShri Abhyankar   PetscErrorCode  ierr;
2302b4ed282SShri Abhyankar   SNES_VI       *vi = (SNES_VI*)snes->data;
2312b4ed282SShri Abhyankar   Vec             Xl = vi->xl,Xu = vi->xu,F = snes->vec_func;
2322b4ed282SShri Abhyankar   PetscScalar     *phi_arr,*x_arr,*f_arr,*l,*u,t;
2332b4ed282SShri Abhyankar   PetscInt        i,nlocal;
2342b4ed282SShri Abhyankar 
2352b4ed282SShri Abhyankar   PetscFunctionBegin;
2362b4ed282SShri Abhyankar   ierr = (*vi->computeuserfunction)(snes,X,F,functx);CHKERRQ(ierr);
2372b4ed282SShri Abhyankar   ierr = VecGetLocalSize(X,&nlocal);CHKERRQ(ierr);
2382b4ed282SShri Abhyankar 
2392b4ed282SShri Abhyankar   ierr = VecGetArray(X,&x_arr);CHKERRQ(ierr);
2402b4ed282SShri Abhyankar   ierr = VecGetArray(F,&f_arr);CHKERRQ(ierr);
2412b4ed282SShri Abhyankar   ierr = VecGetArray(Xl,&l);CHKERRQ(ierr);
2422b4ed282SShri Abhyankar   ierr = VecGetArray(Xu,&u);CHKERRQ(ierr);
2432b4ed282SShri Abhyankar   ierr = VecGetArray(phi,&phi_arr);CHKERRQ(ierr);
2442b4ed282SShri Abhyankar 
2452b4ed282SShri Abhyankar   for (i=0;i < nlocal;i++) {
2462b4ed282SShri Abhyankar     if ((l[i] <= PETSC_VI_NINF) && (u[i] >= PETSC_VI_INF)) {
2472b4ed282SShri Abhyankar       phi_arr[i] = -f_arr[i];
2482b4ed282SShri Abhyankar     }
2492b4ed282SShri Abhyankar     else if (l[i] <= PETSC_VI_NINF) {
2502b4ed282SShri Abhyankar       t = u[i] - x_arr[i];
2512b4ed282SShri Abhyankar       ierr = ComputeFischerFunction(t,-f_arr[i],&phi_arr[i]);CHKERRQ(ierr);
2522b4ed282SShri Abhyankar       phi_arr[i] = -phi_arr[i];
2532b4ed282SShri Abhyankar     }
2542b4ed282SShri Abhyankar     else if (u[i] >= PETSC_VI_INF) {
2552b4ed282SShri Abhyankar       t = x_arr[i] - l[i];
2562b4ed282SShri Abhyankar       ierr = ComputeFischerFunction(t,f_arr[i],&phi_arr[i]);CHKERRQ(ierr);
2572b4ed282SShri Abhyankar     }
2582b4ed282SShri Abhyankar     else if (l[i] == u[i]) {
2592b4ed282SShri Abhyankar       phi_arr[i] = l[i] - x_arr[i];
2602b4ed282SShri Abhyankar     }
2612b4ed282SShri Abhyankar     else {
2622b4ed282SShri Abhyankar       t = u[i] - x_arr[i];
2632b4ed282SShri Abhyankar       ierr = ComputeFischerFunction(t,-f_arr[i],&phi_arr[i]);
2642b4ed282SShri Abhyankar       t = x_arr[i] - l[i];
2652b4ed282SShri Abhyankar       ierr = ComputeFischerFunction(t,phi_arr[i],&phi_arr[i]);
2662b4ed282SShri Abhyankar     }
2672b4ed282SShri Abhyankar   }
2682b4ed282SShri Abhyankar 
2692b4ed282SShri Abhyankar   ierr = VecRestoreArray(X,&x_arr);CHKERRQ(ierr);
2702b4ed282SShri Abhyankar   ierr = VecRestoreArray(F,&f_arr);CHKERRQ(ierr);
2712b4ed282SShri Abhyankar   ierr = VecRestoreArray(Xl,&l);CHKERRQ(ierr);
2722b4ed282SShri Abhyankar   ierr = VecRestoreArray(Xu,&u);CHKERRQ(ierr);
2732b4ed282SShri Abhyankar   ierr = VecRestoreArray(phi,&phi_arr);CHKERRQ(ierr);
2742b4ed282SShri Abhyankar 
2752b4ed282SShri Abhyankar   PetscFunctionReturn(0);
2762b4ed282SShri Abhyankar }
2772b4ed282SShri Abhyankar 
2782b4ed282SShri Abhyankar /*
279a79edbefSShri Abhyankar    SNESVIComputeBsubdifferentialVectors - Computes the diagonal shift (Da) and row scaling (Db) vectors needed for the
280a79edbefSShri Abhyankar                                           the semismooth jacobian.
2812b4ed282SShri Abhyankar */
2822b4ed282SShri Abhyankar #undef __FUNCT__
283a79edbefSShri Abhyankar #define __FUNCT__ "SNESVIComputeBsubdifferentialVectors"
284a79edbefSShri Abhyankar PetscErrorCode SNESVIComputeBsubdifferentialVectors(SNES snes,Vec X,Vec F,Mat jac,Vec Da,Vec Db)
2852b4ed282SShri Abhyankar {
2862b4ed282SShri Abhyankar   PetscErrorCode ierr;
2872b4ed282SShri Abhyankar   SNES_VI      *vi = (SNES_VI*)snes->data;
2882b4ed282SShri Abhyankar   PetscScalar    *l,*u,*x,*f,*da,*db,*z,*t,t1,t2,ci,di,ei;
2892b4ed282SShri Abhyankar   PetscInt       i,nlocal;
2902b4ed282SShri Abhyankar 
2912b4ed282SShri Abhyankar   PetscFunctionBegin;
2922b4ed282SShri Abhyankar 
2932b4ed282SShri Abhyankar   ierr = VecGetArray(X,&x);CHKERRQ(ierr);
2942b4ed282SShri Abhyankar   ierr = VecGetArray(F,&f);CHKERRQ(ierr);
2952b4ed282SShri Abhyankar   ierr = VecGetArray(vi->xl,&l);CHKERRQ(ierr);
2962b4ed282SShri Abhyankar   ierr = VecGetArray(vi->xu,&u);CHKERRQ(ierr);
297a79edbefSShri Abhyankar   ierr = VecGetArray(Da,&da);CHKERRQ(ierr);
298a79edbefSShri Abhyankar   ierr = VecGetArray(Db,&db);CHKERRQ(ierr);
2992b4ed282SShri Abhyankar   ierr = VecGetArray(vi->z,&z);CHKERRQ(ierr);
3002b4ed282SShri Abhyankar 
3012b4ed282SShri Abhyankar   ierr = VecGetLocalSize(X,&nlocal);CHKERRQ(ierr);
3022b4ed282SShri Abhyankar   /* Set the elements of the vector z:
3032b4ed282SShri Abhyankar      z[i] = 1 if (x[i] - l[i],f[i]) = (0,0) or (u[i] - x[i],f[i]) = (0,0)
3042b4ed282SShri Abhyankar      else z[i] = 0
3052b4ed282SShri Abhyankar   */
3062b4ed282SShri Abhyankar   for(i=0;i < nlocal;i++) {
3072b4ed282SShri Abhyankar     da[i] = db[i] = z[i] = 0;
3082b4ed282SShri Abhyankar     if(PetscAbsScalar(f[i]) <= vi->const_tol) {
3092b4ed282SShri Abhyankar       if ((l[i] > PETSC_VI_NINF) && (PetscAbsScalar(x[i]-l[i]) <= vi->const_tol)) {
3102b4ed282SShri Abhyankar 	da[i] = 1;
3112b4ed282SShri Abhyankar 	z[i]  = 1;
3122b4ed282SShri Abhyankar       }
3132b4ed282SShri Abhyankar       if ((u[i] < PETSC_VI_INF) && (PetscAbsScalar(u[i]-x[i]) <= vi->const_tol)) {
3142b4ed282SShri Abhyankar 	db[i] = 1;
3152b4ed282SShri Abhyankar 	z[i]  = 1;
3162b4ed282SShri Abhyankar       }
3172b4ed282SShri Abhyankar     }
3182b4ed282SShri Abhyankar   }
3192b4ed282SShri Abhyankar   ierr = VecRestoreArray(vi->z,&z);CHKERRQ(ierr);
320a79edbefSShri Abhyankar   ierr = MatMult(jac,vi->z,vi->t);CHKERRQ(ierr);
3212b4ed282SShri Abhyankar   ierr = VecGetArray(vi->t,&t);CHKERRQ(ierr);
3222b4ed282SShri Abhyankar   /* Compute the elements of the diagonal perturbation vector Da and row scaling vector Db */
3232b4ed282SShri Abhyankar   for(i=0;i< nlocal;i++) {
3242b4ed282SShri Abhyankar     /* Free variables */
3252b4ed282SShri Abhyankar     if ((l[i] <= PETSC_VI_NINF) && (u[i] >= PETSC_VI_INF)) {
3262b4ed282SShri Abhyankar       da[i] = 0; db[i] = -1;
3272b4ed282SShri Abhyankar     }
3282b4ed282SShri Abhyankar     /* lower bounded variables */
3292b4ed282SShri Abhyankar     else if (u[i] >= PETSC_VI_INF) {
3302b4ed282SShri Abhyankar       if (da[i] >= 1) {
3312b4ed282SShri Abhyankar 	t2 = PetscScalarNorm(1,t[i]);
3322b4ed282SShri Abhyankar 	da[i] = 1/t2 - 1;
3332b4ed282SShri Abhyankar 	db[i] = t[i]/t2 - 1;
3342b4ed282SShri Abhyankar       } else {
3352b4ed282SShri Abhyankar 	t1 = x[i] - l[i];
3362b4ed282SShri Abhyankar 	t2 = PetscScalarNorm(t1,f[i]);
3372b4ed282SShri Abhyankar 	da[i] = t1/t2 - 1;
3382b4ed282SShri Abhyankar 	db[i] = f[i]/t2 - 1;
3392b4ed282SShri Abhyankar       }
3402b4ed282SShri Abhyankar     }
3412b4ed282SShri Abhyankar     /* upper bounded variables */
3422b4ed282SShri Abhyankar     else if (l[i] <= PETSC_VI_NINF) {
3432b4ed282SShri Abhyankar       if (db[i] >= 1) {
3442b4ed282SShri Abhyankar 	t2 = PetscScalarNorm(1,t[i]);
3452b4ed282SShri Abhyankar 	da[i] = -1/t2 -1;
3462b4ed282SShri Abhyankar 	db[i] = -t[i]/t2 - 1;
3472b4ed282SShri Abhyankar       }
3482b4ed282SShri Abhyankar       else {
3492b4ed282SShri Abhyankar 	t1 = u[i] - x[i];
3502b4ed282SShri Abhyankar 	t2 = PetscScalarNorm(t1,f[i]);
3512b4ed282SShri Abhyankar 	da[i] = t1/t2 - 1;
3522b4ed282SShri Abhyankar 	db[i] = -f[i]/t2 - 1;
3532b4ed282SShri Abhyankar       }
3542b4ed282SShri Abhyankar     }
3552b4ed282SShri Abhyankar     /* Fixed variables */
3562b4ed282SShri Abhyankar     else if (l[i] == u[i]) {
3572b4ed282SShri Abhyankar       da[i] = -1;
3582b4ed282SShri Abhyankar       db[i] = 0;
3592b4ed282SShri Abhyankar     }
3602b4ed282SShri Abhyankar     /* Box constrained variables */
3612b4ed282SShri Abhyankar     else {
3622b4ed282SShri Abhyankar       if (db[i] >= 1) {
3632b4ed282SShri Abhyankar 	t2 = PetscScalarNorm(1,t[i]);
3642b4ed282SShri Abhyankar 	ci = 1/t2 + 1;
3652b4ed282SShri Abhyankar 	di = t[i]/t2 + 1;
3662b4ed282SShri Abhyankar       }
3672b4ed282SShri Abhyankar       else {
3682b4ed282SShri Abhyankar 	t1 = x[i] - u[i];
3692b4ed282SShri Abhyankar 	t2 = PetscScalarNorm(t1,f[i]);
3702b4ed282SShri Abhyankar 	ci = t1/t2 + 1;
3712b4ed282SShri Abhyankar 	di = f[i]/t2 + 1;
3722b4ed282SShri Abhyankar       }
3732b4ed282SShri Abhyankar 
3742b4ed282SShri Abhyankar       if (da[i] >= 1) {
3752b4ed282SShri Abhyankar 	t1 = ci + di*t[i];
3762b4ed282SShri Abhyankar 	t2 = PetscScalarNorm(1,t1);
3772b4ed282SShri Abhyankar 	t1 = t1/t2 - 1;
3782b4ed282SShri Abhyankar 	t2 = 1/t2  - 1;
3792b4ed282SShri Abhyankar       }
3802b4ed282SShri Abhyankar       else {
3812b4ed282SShri Abhyankar 	ierr = ComputeFischerFunction(u[i]-x[i],-f[i],&ei);CHKERRQ(ierr);
3822b4ed282SShri Abhyankar 	t2 = PetscScalarNorm(x[i]-l[i],ei);
3832b4ed282SShri Abhyankar 	t1 = ei/t2 - 1;
3842b4ed282SShri Abhyankar 	t2 = (x[i] - l[i])/t2 - 1;
3852b4ed282SShri Abhyankar       }
3862b4ed282SShri Abhyankar 
3872b4ed282SShri Abhyankar       da[i] = t2 + t1*ci;
3882b4ed282SShri Abhyankar       db[i] = t1*di;
3892b4ed282SShri Abhyankar     }
3902b4ed282SShri Abhyankar   }
3912b4ed282SShri Abhyankar   ierr = VecRestoreArray(X,&x);CHKERRQ(ierr);
3922b4ed282SShri Abhyankar   ierr = VecRestoreArray(F,&f);CHKERRQ(ierr);
3932b4ed282SShri Abhyankar   ierr = VecRestoreArray(vi->xl,&l);CHKERRQ(ierr);
3942b4ed282SShri Abhyankar   ierr = VecRestoreArray(vi->xu,&u);CHKERRQ(ierr);
395a79edbefSShri Abhyankar   ierr = VecRestoreArray(Da,&da);CHKERRQ(ierr);
396a79edbefSShri Abhyankar   ierr = VecRestoreArray(Db,&db);CHKERRQ(ierr);
3972b4ed282SShri Abhyankar   ierr = VecRestoreArray(vi->t,&t);CHKERRQ(ierr);
3982b4ed282SShri Abhyankar 
399a79edbefSShri Abhyankar   PetscFunctionReturn(0);
400a79edbefSShri Abhyankar }
401a79edbefSShri Abhyankar 
402a79edbefSShri Abhyankar /*
403a79edbefSShri 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.
404a79edbefSShri Abhyankar 
405a79edbefSShri Abhyankar    Input Parameters:
406a79edbefSShri Abhyankar .  Da       - Diagonal shift vector for the semismooth jacobian.
407a79edbefSShri Abhyankar .  Db       - Row scaling vector for the semismooth jacobian.
408a79edbefSShri Abhyankar 
409a79edbefSShri Abhyankar    Output Parameters:
410a79edbefSShri Abhyankar .  jac      - semismooth jacobian
411a79edbefSShri Abhyankar .  jac_pre  - optional preconditioning matrix
412a79edbefSShri Abhyankar 
413a79edbefSShri Abhyankar    Notes:
414a79edbefSShri Abhyankar    The semismooth jacobian matrix is given by
415a79edbefSShri Abhyankar    jac = Da + Db*jacfun
416a79edbefSShri Abhyankar    where Db is the row scaling matrix stored as a vector,
417a79edbefSShri Abhyankar          Da is the diagonal perturbation matrix stored as a vector
418a79edbefSShri Abhyankar    and   jacfun is the jacobian of the original nonlinear function.
419a79edbefSShri Abhyankar */
420a79edbefSShri Abhyankar #undef __FUNCT__
421a79edbefSShri Abhyankar #define __FUNCT__ "SNESVIComputeJacobian"
422a79edbefSShri Abhyankar PetscErrorCode SNESVIComputeJacobian(Mat jac, Mat jac_pre,Vec Da, Vec Db)
423a79edbefSShri Abhyankar {
424a79edbefSShri Abhyankar   PetscErrorCode ierr;
425a79edbefSShri Abhyankar 
4262b4ed282SShri Abhyankar   /* Do row scaling  and add diagonal perturbation */
427a79edbefSShri Abhyankar   ierr = MatDiagonalScale(jac,Db,PETSC_NULL);CHKERRQ(ierr);
428a79edbefSShri Abhyankar   ierr = MatDiagonalSet(jac,Da,ADD_VALUES);CHKERRQ(ierr);
429a79edbefSShri Abhyankar   if (jac != jac_pre) { /* If jac and jac_pre are different */
430a79edbefSShri Abhyankar     ierr = MatDiagonalScale(jac_pre,Db,PETSC_NULL);
431a79edbefSShri Abhyankar     ierr = MatDiagonalSet(jac_pre,Da,ADD_VALUES);CHKERRQ(ierr);
4322b4ed282SShri Abhyankar   }
4332b4ed282SShri Abhyankar   PetscFunctionReturn(0);
4342b4ed282SShri Abhyankar }
4352b4ed282SShri Abhyankar 
4362b4ed282SShri Abhyankar /*
437ee657d29SShri Abhyankar    SNESVIComputeMeritFunctionGradient - Computes the gradient of the merit function psi.
438ee657d29SShri Abhyankar 
439ee657d29SShri Abhyankar    Input Parameters:
440ee657d29SShri Abhyankar    phi - semismooth function.
441ee657d29SShri Abhyankar    H   - semismooth jacobian
442ee657d29SShri Abhyankar 
443ee657d29SShri Abhyankar    Output Parameters:
444ee657d29SShri Abhyankar    dpsi - merit function gradient
445ee657d29SShri Abhyankar 
446ee657d29SShri Abhyankar    Notes:
447ee657d29SShri Abhyankar   The merit function gradient is computed as follows
448ee657d29SShri Abhyankar         dpsi = H^T*phi
449ee657d29SShri Abhyankar */
450ee657d29SShri Abhyankar #undef __FUNCT__
451ee657d29SShri Abhyankar #define __FUNCT__ "SNESVIComputeMeritFunctionGradient"
452ee657d29SShri Abhyankar PetscErrorCode SNESVIComputeMeritFunctionGradient(Mat H, Vec phi, Vec dpsi)
453ee657d29SShri Abhyankar {
454ee657d29SShri Abhyankar   PetscErrorCode ierr;
455ee657d29SShri Abhyankar 
456ee657d29SShri Abhyankar   PetscFunctionBegin;
457ee657d29SShri Abhyankar   ierr = MatMultTranspose(H,phi,dpsi);
458ee657d29SShri Abhyankar   PetscFunctionReturn(0);
459ee657d29SShri Abhyankar }
460ee657d29SShri Abhyankar 
461ee657d29SShri Abhyankar /*
4622b4ed282SShri Abhyankar    SNESVIAdjustInitialGuess - Readjusts the initial guess to the SNES solver supplied by the user so that the initial guess lies inside the feasible region .
4632b4ed282SShri Abhyankar 
4642b4ed282SShri Abhyankar    Input Parameters:
4652b4ed282SShri Abhyankar .  lb - lower bound.
4662b4ed282SShri Abhyankar .  ub - upper bound.
4672b4ed282SShri Abhyankar 
4682b4ed282SShri Abhyankar    Output Parameters:
4692b4ed282SShri Abhyankar .  X - the readjusted initial guess.
4702b4ed282SShri Abhyankar 
4712b4ed282SShri Abhyankar    Notes:
4722b4ed282SShri Abhyankar    The readjusted initial guess X[i] = max(max(min(l[i],X[i]),min(X[i],u[i])),min(l[i],u[i]))
4732b4ed282SShri Abhyankar */
4742b4ed282SShri Abhyankar #undef __FUNCT__
4752b4ed282SShri Abhyankar #define __FUNCT__ "SNESVIAdjustInitialGuess"
4762b4ed282SShri Abhyankar PetscErrorCode SNESVIAdjustInitialGuess(Vec X, Vec lb, Vec ub)
4772b4ed282SShri Abhyankar {
4782b4ed282SShri Abhyankar   PetscErrorCode ierr;
4792b4ed282SShri Abhyankar   PetscInt       i,nlocal;
4802b4ed282SShri Abhyankar   PetscScalar    *x,*l,*u;
4812b4ed282SShri Abhyankar 
4822b4ed282SShri Abhyankar   PetscFunctionBegin;
4832b4ed282SShri Abhyankar 
4842b4ed282SShri Abhyankar   ierr = VecGetLocalSize(X,&nlocal);CHKERRQ(ierr);
4852b4ed282SShri Abhyankar   ierr = VecGetArray(X,&x);CHKERRQ(ierr);
4862b4ed282SShri Abhyankar   ierr = VecGetArray(lb,&l);CHKERRQ(ierr);
4872b4ed282SShri Abhyankar   ierr = VecGetArray(ub,&u);CHKERRQ(ierr);
4882b4ed282SShri Abhyankar 
4892b4ed282SShri Abhyankar   for(i = 0; i < nlocal; i++) {
4902b4ed282SShri Abhyankar     x[i] = PetscMax(PetscMax(PetscMin(x[i],l[i]),PetscMin(x[i],u[i])),PetscMin(l[i],u[i]));
4912b4ed282SShri Abhyankar   }
4922b4ed282SShri Abhyankar 
4932b4ed282SShri Abhyankar   ierr = VecRestoreArray(X,&x);CHKERRQ(ierr);
4942b4ed282SShri Abhyankar   ierr = VecRestoreArray(lb,&l);CHKERRQ(ierr);
4952b4ed282SShri Abhyankar   ierr = VecRestoreArray(ub,&u);CHKERRQ(ierr);
4962b4ed282SShri Abhyankar 
4972b4ed282SShri Abhyankar   PetscFunctionReturn(0);
4982b4ed282SShri Abhyankar }
4992b4ed282SShri Abhyankar 
5002b4ed282SShri Abhyankar /*  --------------------------------------------------------------------
5012b4ed282SShri Abhyankar 
5022b4ed282SShri Abhyankar      This file implements a semismooth truncated Newton method with a line search,
5032b4ed282SShri Abhyankar      for solving a system of nonlinear equations in complementarity form, using the KSP, Vec,
5042b4ed282SShri Abhyankar      and Mat interfaces for linear solvers, vectors, and matrices,
5052b4ed282SShri Abhyankar      respectively.
5062b4ed282SShri Abhyankar 
5072b4ed282SShri Abhyankar      The following basic routines are required for each nonlinear solver:
5082b4ed282SShri Abhyankar           SNESCreate_XXX()          - Creates a nonlinear solver context
5092b4ed282SShri Abhyankar           SNESSetFromOptions_XXX()  - Sets runtime options
5102b4ed282SShri Abhyankar           SNESSolve_XXX()           - Solves the nonlinear system
5112b4ed282SShri Abhyankar           SNESDestroy_XXX()         - Destroys the nonlinear solver context
5122b4ed282SShri Abhyankar      The suffix "_XXX" denotes a particular implementation, in this case
5132b4ed282SShri Abhyankar      we use _VI (e.g., SNESCreate_VI, SNESSolve_VI) for solving
5142b4ed282SShri Abhyankar      systems of nonlinear equations with a line search (LS) method.
5152b4ed282SShri Abhyankar      These routines are actually called via the common user interface
5162b4ed282SShri Abhyankar      routines SNESCreate(), SNESSetFromOptions(), SNESSolve(), and
5172b4ed282SShri Abhyankar      SNESDestroy(), so the application code interface remains identical
5182b4ed282SShri Abhyankar      for all nonlinear solvers.
5192b4ed282SShri Abhyankar 
5202b4ed282SShri Abhyankar      Another key routine is:
5212b4ed282SShri Abhyankar           SNESSetUp_XXX()           - Prepares for the use of a nonlinear solver
5222b4ed282SShri Abhyankar      by setting data structures and options.   The interface routine SNESSetUp()
5232b4ed282SShri Abhyankar      is not usually called directly by the user, but instead is called by
5242b4ed282SShri Abhyankar      SNESSolve() if necessary.
5252b4ed282SShri Abhyankar 
5262b4ed282SShri Abhyankar      Additional basic routines are:
5272b4ed282SShri Abhyankar           SNESView_XXX()            - Prints details of runtime options that
5282b4ed282SShri Abhyankar                                       have actually been used.
5292b4ed282SShri Abhyankar      These are called by application codes via the interface routines
5302b4ed282SShri Abhyankar      SNESView().
5312b4ed282SShri Abhyankar 
5322b4ed282SShri Abhyankar      The various types of solvers (preconditioners, Krylov subspace methods,
5332b4ed282SShri Abhyankar      nonlinear solvers, timesteppers) are all organized similarly, so the
5342b4ed282SShri Abhyankar      above description applies to these categories also.
5352b4ed282SShri Abhyankar 
5362b4ed282SShri Abhyankar     -------------------------------------------------------------------- */
5372b4ed282SShri Abhyankar /*
53869c03620SShri Abhyankar    SNESSolveVI_SS - Solves the complementarity problem with a semismooth Newton
5392b4ed282SShri Abhyankar    method using a line search.
5402b4ed282SShri Abhyankar 
5412b4ed282SShri Abhyankar    Input Parameters:
5422b4ed282SShri Abhyankar .  snes - the SNES context
5432b4ed282SShri Abhyankar 
5442b4ed282SShri Abhyankar    Output Parameter:
5452b4ed282SShri Abhyankar .  outits - number of iterations until termination
5462b4ed282SShri Abhyankar 
5472b4ed282SShri Abhyankar    Application Interface Routine: SNESSolve()
5482b4ed282SShri Abhyankar 
5492b4ed282SShri Abhyankar    Notes:
5502b4ed282SShri Abhyankar    This implements essentially a semismooth Newton method with a
5512b4ed282SShri Abhyankar    line search.  By default a cubic backtracking line search
5522b4ed282SShri Abhyankar    is employed, as described in the text "Numerical Methods for
5532b4ed282SShri Abhyankar    Unconstrained Optimization and Nonlinear Equations" by Dennis
5542b4ed282SShri Abhyankar    and Schnabel.
5552b4ed282SShri Abhyankar */
5562b4ed282SShri Abhyankar #undef __FUNCT__
55769c03620SShri Abhyankar #define __FUNCT__ "SNESSolveVI_SS"
55869c03620SShri Abhyankar PetscErrorCode SNESSolveVI_SS(SNES snes)
5592b4ed282SShri Abhyankar {
5602b4ed282SShri Abhyankar   SNES_VI            *vi = (SNES_VI*)snes->data;
5612b4ed282SShri Abhyankar   PetscErrorCode     ierr;
5622b4ed282SShri Abhyankar   PetscInt           maxits,i,lits;
5633b336b49SShri Abhyankar   PetscBool          lssucceed;
5642b4ed282SShri Abhyankar   MatStructure       flg = DIFFERENT_NONZERO_PATTERN;
5652b4ed282SShri Abhyankar   PetscReal          gnorm,xnorm=0,ynorm;
5662b4ed282SShri Abhyankar   Vec                Y,X,F,G,W;
5672b4ed282SShri Abhyankar   KSPConvergedReason kspreason;
5682b4ed282SShri Abhyankar 
5692b4ed282SShri Abhyankar   PetscFunctionBegin;
5702b4ed282SShri Abhyankar   snes->numFailures            = 0;
5712b4ed282SShri Abhyankar   snes->numLinearSolveFailures = 0;
5722b4ed282SShri Abhyankar   snes->reason                 = SNES_CONVERGED_ITERATING;
5732b4ed282SShri Abhyankar 
5742b4ed282SShri Abhyankar   maxits	= snes->max_its;	/* maximum number of iterations */
5752b4ed282SShri Abhyankar   X		= snes->vec_sol;	/* solution vector */
5762b4ed282SShri Abhyankar   F		= snes->vec_func;	/* residual vector */
5772b4ed282SShri Abhyankar   Y		= snes->work[0];	/* work vectors */
5782b4ed282SShri Abhyankar   G		= snes->work[1];
5792b4ed282SShri Abhyankar   W		= snes->work[2];
5802b4ed282SShri Abhyankar 
5812b4ed282SShri Abhyankar   ierr = PetscObjectTakeAccess(snes);CHKERRQ(ierr);
5822b4ed282SShri Abhyankar   snes->iter = 0;
5832b4ed282SShri Abhyankar   snes->norm = 0.0;
5842b4ed282SShri Abhyankar   ierr = PetscObjectGrantAccess(snes);CHKERRQ(ierr);
5852b4ed282SShri Abhyankar 
5862b4ed282SShri Abhyankar   ierr = SNESVIAdjustInitialGuess(X,vi->xl,vi->xu);CHKERRQ(ierr);
5872b4ed282SShri Abhyankar   ierr = SNESComputeFunction(snes,X,vi->phi);CHKERRQ(ierr);
5882b4ed282SShri Abhyankar   if (snes->domainerror) {
5892b4ed282SShri Abhyankar     snes->reason = SNES_DIVERGED_FUNCTION_DOMAIN;
5902b4ed282SShri Abhyankar     PetscFunctionReturn(0);
5912b4ed282SShri Abhyankar   }
5922b4ed282SShri Abhyankar    /* Compute Merit function */
5932b4ed282SShri Abhyankar   ierr = SNESVIComputeMeritFunction(vi->phi,&vi->merit,&vi->phinorm);CHKERRQ(ierr);
5942b4ed282SShri Abhyankar 
5952b4ed282SShri Abhyankar   ierr = VecNormBegin(X,NORM_2,&xnorm);CHKERRQ(ierr);	/* xnorm <- ||x||  */
5962b4ed282SShri Abhyankar   ierr = VecNormEnd(X,NORM_2,&xnorm);CHKERRQ(ierr);
5972b4ed282SShri Abhyankar   if PetscIsInfOrNanReal(vi->merit) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FP,"User provided compute function generated a Not-a-Number");
5982b4ed282SShri Abhyankar 
5992b4ed282SShri Abhyankar   ierr = PetscObjectTakeAccess(snes);CHKERRQ(ierr);
6002b4ed282SShri Abhyankar   snes->norm = vi->phinorm;
6012b4ed282SShri Abhyankar   ierr = PetscObjectGrantAccess(snes);CHKERRQ(ierr);
6022b4ed282SShri Abhyankar   SNESLogConvHistory(snes,vi->phinorm,0);
6032b4ed282SShri Abhyankar   SNESMonitor(snes,0,vi->phinorm);
6042b4ed282SShri Abhyankar 
6052b4ed282SShri Abhyankar   /* set parameter for default relative tolerance convergence test */
6062b4ed282SShri Abhyankar   snes->ttol = vi->phinorm*snes->rtol;
6072b4ed282SShri Abhyankar   /* test convergence */
6082b4ed282SShri Abhyankar   ierr = (*snes->ops->converged)(snes,0,0.0,0.0,vi->phinorm,&snes->reason,snes->cnvP);CHKERRQ(ierr);
6092b4ed282SShri Abhyankar   if (snes->reason) PetscFunctionReturn(0);
6102b4ed282SShri Abhyankar 
6112b4ed282SShri Abhyankar   for (i=0; i<maxits; i++) {
6122b4ed282SShri Abhyankar 
6132b4ed282SShri Abhyankar     /* Call general purpose update function */
6142b4ed282SShri Abhyankar     if (snes->ops->update) {
6152b4ed282SShri Abhyankar       ierr = (*snes->ops->update)(snes, snes->iter);CHKERRQ(ierr);
6162b4ed282SShri Abhyankar     }
6172b4ed282SShri Abhyankar 
6182b4ed282SShri Abhyankar     /* Solve J Y = Phi, where J is the semismooth jacobian */
619a79edbefSShri Abhyankar     /* Get the nonlinear function jacobian */
6202b4ed282SShri Abhyankar     ierr = SNESComputeJacobian(snes,X,&snes->jacobian,&snes->jacobian_pre,&flg);CHKERRQ(ierr);
621a79edbefSShri Abhyankar     /* Get the diagonal shift and row scaling vectors */
622a79edbefSShri Abhyankar     ierr = SNESVIComputeBsubdifferentialVectors(snes,X,F,snes->jacobian,vi->Da,vi->Db);CHKERRQ(ierr);
623a79edbefSShri Abhyankar     /* Compute the semismooth jacobian */
624a79edbefSShri Abhyankar     ierr = SNESVIComputeJacobian(snes->jacobian,snes->jacobian_pre,vi->Da,vi->Db);CHKERRQ(ierr);
625ee657d29SShri Abhyankar     /* Compute the merit function gradient */
626ee657d29SShri Abhyankar     ierr = SNESVIComputeMeritFunctionGradient(snes->jacobian,vi->phi,vi->dpsi);CHKERRQ(ierr);
6272b4ed282SShri Abhyankar     ierr = KSPSetOperators(snes->ksp,snes->jacobian,snes->jacobian_pre,flg);CHKERRQ(ierr);
6282b4ed282SShri Abhyankar     ierr = SNES_KSPSolve(snes,snes->ksp,vi->phi,Y);CHKERRQ(ierr);
6292b4ed282SShri Abhyankar     ierr = KSPGetConvergedReason(snes->ksp,&kspreason);CHKERRQ(ierr);
6303b336b49SShri Abhyankar 
6313b336b49SShri Abhyankar     if (kspreason < 0) {
6322b4ed282SShri Abhyankar       if (++snes->numLinearSolveFailures >= snes->maxLinearSolveFailures) {
6332b4ed282SShri 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);
6342b4ed282SShri Abhyankar         snes->reason = SNES_DIVERGED_LINEAR_SOLVE;
6352b4ed282SShri Abhyankar         break;
6362b4ed282SShri Abhyankar       }
6372b4ed282SShri Abhyankar     }
6382b4ed282SShri Abhyankar     ierr = KSPGetIterationNumber(snes->ksp,&lits);CHKERRQ(ierr);
6392b4ed282SShri Abhyankar     snes->linear_its += lits;
6402b4ed282SShri Abhyankar     ierr = PetscInfo2(snes,"iter=%D, linear solve iterations=%D\n",snes->iter,lits);CHKERRQ(ierr);
6412b4ed282SShri Abhyankar     /*
6422b4ed282SShri Abhyankar     if (vi->precheckstep) {
643ace3abfcSBarry Smith       PetscBool changed_y = PETSC_FALSE;
6442b4ed282SShri Abhyankar       ierr = (*vi->precheckstep)(snes,X,Y,vi->precheck,&changed_y);CHKERRQ(ierr);
6452b4ed282SShri Abhyankar     }
6462b4ed282SShri Abhyankar 
6472b4ed282SShri Abhyankar     if (PetscLogPrintInfo){
6482b4ed282SShri Abhyankar       ierr = SNESVICheckResidual_Private(snes,snes->jacobian,F,Y,G,W);CHKERRQ(ierr);
6492b4ed282SShri Abhyankar     }
6502b4ed282SShri Abhyankar     */
6512b4ed282SShri Abhyankar     /* Compute a (scaled) negative update in the line search routine:
6522b4ed282SShri Abhyankar          Y <- X - lambda*Y
6532b4ed282SShri Abhyankar        and evaluate G = function(Y) (depends on the line search).
6542b4ed282SShri Abhyankar     */
6552b4ed282SShri Abhyankar     ierr = VecCopy(Y,snes->vec_sol_update);CHKERRQ(ierr);
6562b4ed282SShri Abhyankar     ynorm = 1; gnorm = vi->phinorm;
6572b4ed282SShri Abhyankar     ierr = (*vi->LineSearch)(snes,vi->lsP,X,vi->phi,G,Y,W,vi->phinorm,xnorm,&ynorm,&gnorm,&lssucceed);CHKERRQ(ierr);
6582b4ed282SShri Abhyankar     ierr = PetscInfo4(snes,"fnorm=%18.16e, gnorm=%18.16e, ynorm=%18.16e, lssucceed=%d\n",vi->phinorm,gnorm,ynorm,(int)lssucceed);CHKERRQ(ierr);
6592b4ed282SShri Abhyankar     if (snes->reason == SNES_DIVERGED_FUNCTION_COUNT) break;
6602b4ed282SShri Abhyankar     if (snes->domainerror) {
6612b4ed282SShri Abhyankar       snes->reason = SNES_DIVERGED_FUNCTION_DOMAIN;
6622b4ed282SShri Abhyankar       PetscFunctionReturn(0);
6632b4ed282SShri Abhyankar     }
6642b4ed282SShri Abhyankar     if (!lssucceed) {
6652b4ed282SShri Abhyankar       if (++snes->numFailures >= snes->maxFailures) {
666ace3abfcSBarry Smith 	PetscBool ismin;
6672b4ed282SShri Abhyankar         snes->reason = SNES_DIVERGED_LINE_SEARCH;
6682b4ed282SShri Abhyankar         ierr = SNESVICheckLocalMin_Private(snes,snes->jacobian,G,W,gnorm,&ismin);CHKERRQ(ierr);
6692b4ed282SShri Abhyankar         if (ismin) snes->reason = SNES_DIVERGED_LOCAL_MIN;
6702b4ed282SShri Abhyankar         break;
6712b4ed282SShri Abhyankar       }
6722b4ed282SShri Abhyankar     }
6732b4ed282SShri Abhyankar     /* Update function and solution vectors */
6742b4ed282SShri Abhyankar     vi->phinorm = gnorm;
6752b4ed282SShri Abhyankar     vi->merit = 0.5*vi->phinorm*vi->phinorm;
6762b4ed282SShri Abhyankar     ierr = VecCopy(G,vi->phi);CHKERRQ(ierr);
6772b4ed282SShri Abhyankar     ierr = VecCopy(W,X);CHKERRQ(ierr);
6782b4ed282SShri Abhyankar     /* Monitor convergence */
6792b4ed282SShri Abhyankar     ierr = PetscObjectTakeAccess(snes);CHKERRQ(ierr);
6802b4ed282SShri Abhyankar     snes->iter = i+1;
6812b4ed282SShri Abhyankar     snes->norm = vi->phinorm;
6822b4ed282SShri Abhyankar     ierr = PetscObjectGrantAccess(snes);CHKERRQ(ierr);
6832b4ed282SShri Abhyankar     SNESLogConvHistory(snes,snes->norm,lits);
6842b4ed282SShri Abhyankar     SNESMonitor(snes,snes->iter,snes->norm);
6852b4ed282SShri Abhyankar     /* Test for convergence, xnorm = || X || */
6862b4ed282SShri Abhyankar     if (snes->ops->converged != SNESSkipConverged) { ierr = VecNorm(X,NORM_2,&xnorm);CHKERRQ(ierr); }
6872b4ed282SShri Abhyankar     ierr = (*snes->ops->converged)(snes,snes->iter,xnorm,ynorm,vi->phinorm,&snes->reason,snes->cnvP);CHKERRQ(ierr);
6882b4ed282SShri Abhyankar     if (snes->reason) break;
6892b4ed282SShri Abhyankar   }
6902b4ed282SShri Abhyankar   if (i == maxits) {
6912b4ed282SShri Abhyankar     ierr = PetscInfo1(snes,"Maximum number of iterations has been reached: %D\n",maxits);CHKERRQ(ierr);
6922b4ed282SShri Abhyankar     if(!snes->reason) snes->reason = SNES_DIVERGED_MAX_IT;
6932b4ed282SShri Abhyankar   }
6942b4ed282SShri Abhyankar   PetscFunctionReturn(0);
6952b4ed282SShri Abhyankar }
69669c03620SShri Abhyankar 
69769c03620SShri Abhyankar #undef __FUNCT__
69869c03620SShri Abhyankar #define __FUNCT__ "SNESVICreateIndexSets_AS"
699a79edbefSShri Abhyankar PetscErrorCode SNESVICreateIndexSets_AS(SNES snes,Vec Db,PetscReal thresh,IS* ISact,IS* ISinact)
70069c03620SShri Abhyankar {
70169c03620SShri Abhyankar   PetscErrorCode ierr;
70269c03620SShri Abhyankar   PetscInt       i,nlocal,ilow,ihigh,nloc_isact=0,nloc_isinact=0;
70369c03620SShri Abhyankar   PetscInt       *idx_act,*idx_inact,i1=0,i2=0;
70469c03620SShri Abhyankar   PetscScalar    *db;
70569c03620SShri Abhyankar 
70669c03620SShri Abhyankar   PetscFunctionBegin;
70769c03620SShri Abhyankar 
70869c03620SShri Abhyankar   ierr = VecGetLocalSize(Db,&nlocal);CHKERRQ(ierr);
70969c03620SShri Abhyankar   ierr = VecGetOwnershipRange(Db,&ilow,&ihigh);CHKERRQ(ierr);
71069c03620SShri Abhyankar   ierr = VecGetArray(Db,&db);CHKERRQ(ierr);
71169c03620SShri Abhyankar   /* Compute the sizes of the active and inactive sets */
71269c03620SShri Abhyankar   for (i=0; i < nlocal;i++) {
713fca35906SShri Abhyankar     if (PetscAbsScalar(db[i]) <= thresh) nloc_isact++;
714fca35906SShri Abhyankar     else nloc_isinact++;
71569c03620SShri Abhyankar   }
71669c03620SShri Abhyankar   ierr = PetscMalloc(nloc_isact*sizeof(PetscInt),&idx_act);CHKERRQ(ierr);
71769c03620SShri Abhyankar   ierr = PetscMalloc(nloc_isinact*sizeof(PetscInt),&idx_inact);CHKERRQ(ierr);
71869c03620SShri Abhyankar 
71969c03620SShri Abhyankar   /* Creating the indexing arrays */
720fca35906SShri Abhyankar   for(i=0; i < nlocal; i++) {
721fca35906SShri Abhyankar     if (PetscAbsScalar(db[i]) <= thresh) idx_act[i1++] = ilow+i;
722fca35906SShri Abhyankar     else idx_inact[i2++] = ilow+i;
72369c03620SShri Abhyankar   }
72469c03620SShri Abhyankar 
72569c03620SShri Abhyankar   /* Create the index sets */
72669c03620SShri Abhyankar   ierr = ISCreateGeneral(((PetscObject)snes)->comm,nloc_isact,idx_act,PETSC_COPY_VALUES,ISact);CHKERRQ(ierr);
72769c03620SShri Abhyankar   ierr = ISCreateGeneral(((PetscObject)snes)->comm,nloc_isinact,idx_inact,PETSC_COPY_VALUES,ISinact);CHKERRQ(ierr);
72869c03620SShri Abhyankar 
72969c03620SShri Abhyankar   ierr = VecRestoreArray(Db,&db);CHKERRQ(ierr);
73069c03620SShri Abhyankar   ierr = PetscFree(idx_act);CHKERRQ(ierr);
73169c03620SShri Abhyankar   ierr = PetscFree(idx_inact);CHKERRQ(ierr);
73269c03620SShri Abhyankar   PetscFunctionReturn(0);
73369c03620SShri Abhyankar }
73469c03620SShri Abhyankar 
735d950fb63SShri Abhyankar #undef __FUNCT__
736d950fb63SShri Abhyankar #define __FUNCT__ "SNESVICreateIndexSets_RS"
737d950fb63SShri Abhyankar PetscErrorCode SNESVICreateIndexSets_RS(SNES snes,Vec X,Vec Xl, Vec Xu,IS* ISact,IS* ISinact)
738d950fb63SShri Abhyankar {
739d950fb63SShri Abhyankar   PetscErrorCode ierr;
740d950fb63SShri Abhyankar   SNES_VI        *vi = (SNES_VI*)snes->data;
741d950fb63SShri Abhyankar   PetscInt       i,nlocal,ilow,ihigh,nloc_isact=0,nloc_isinact=0;
742d950fb63SShri Abhyankar   PetscInt       *idx_act,*idx_inact,i1=0,i2=0;
743d950fb63SShri Abhyankar   PetscScalar    *x,*l,*u,*f;
744d950fb63SShri Abhyankar   Vec            F = snes->vec_func;
745d950fb63SShri Abhyankar 
746d950fb63SShri Abhyankar   PetscFunctionBegin;
747d950fb63SShri Abhyankar 
748d950fb63SShri Abhyankar   ierr = VecGetLocalSize(X,&nlocal);CHKERRQ(ierr);
749d950fb63SShri Abhyankar   ierr = VecGetOwnershipRange(X,&ilow,&ihigh);CHKERRQ(ierr);
750d950fb63SShri Abhyankar   ierr = VecGetArray(X,&x);CHKERRQ(ierr);
751d950fb63SShri Abhyankar   ierr = VecGetArray(Xl,&l);CHKERRQ(ierr);
752d950fb63SShri Abhyankar   ierr = VecGetArray(Xu,&u);CHKERRQ(ierr);
753d950fb63SShri Abhyankar   ierr = VecGetArray(F,&f);CHKERRQ(ierr);
754d950fb63SShri Abhyankar   /* Compute the sizes of the active and inactive sets */
755d950fb63SShri Abhyankar   for (i=0; i < nlocal;i++) {
756d950fb63SShri Abhyankar     if (PetscAbsScalar(x[i] - l[i]) <= vi->const_tol && f[i] > vi->const_tol) nloc_isact++;
757d950fb63SShri Abhyankar     else if (PetscAbsScalar(u[i] - x[i]) <= vi->const_tol && f[i] < vi->const_tol) nloc_isact++;
758d950fb63SShri Abhyankar     else nloc_isinact++;
759d950fb63SShri Abhyankar   }
760d950fb63SShri Abhyankar   ierr = PetscMalloc(nloc_isact*sizeof(PetscInt),&idx_act);CHKERRQ(ierr);
761d950fb63SShri Abhyankar   ierr = PetscMalloc(nloc_isinact*sizeof(PetscInt),&idx_inact);CHKERRQ(ierr);
762d950fb63SShri Abhyankar 
763d950fb63SShri Abhyankar   /* Creating the indexing arrays */
764d950fb63SShri Abhyankar   for(i=0; i < nlocal; i++) {
765d950fb63SShri Abhyankar     if (PetscAbsScalar(x[i] - l[i]) <= vi->const_tol && f[i] > vi->const_tol) idx_act[i1++] = ilow+i;
766d950fb63SShri Abhyankar     else if (PetscAbsScalar(u[i] - x[i]) <= vi->const_tol && f[i] < vi->const_tol) idx_act[i1++] = ilow+i;
767d950fb63SShri Abhyankar     else idx_inact[i2++] = ilow+i;
768d950fb63SShri Abhyankar   }
769d950fb63SShri Abhyankar 
770d950fb63SShri Abhyankar   /* Create the index sets */
771d950fb63SShri Abhyankar   ierr = ISCreateGeneral(((PetscObject)snes)->comm,nloc_isact,idx_act,PETSC_COPY_VALUES,ISact);CHKERRQ(ierr);
772d950fb63SShri Abhyankar   ierr = ISCreateGeneral(((PetscObject)snes)->comm,nloc_isinact,idx_inact,PETSC_COPY_VALUES,ISinact);CHKERRQ(ierr);
773d950fb63SShri Abhyankar 
774d950fb63SShri Abhyankar   ierr = VecRestoreArray(X,&x);CHKERRQ(ierr);
775d950fb63SShri Abhyankar   ierr = VecRestoreArray(Xl,&l);CHKERRQ(ierr);
776d950fb63SShri Abhyankar   ierr = VecRestoreArray(Xu,&u);CHKERRQ(ierr);
777d950fb63SShri Abhyankar   ierr = VecRestoreArray(F,&f);CHKERRQ(ierr);
778d950fb63SShri Abhyankar   ierr = PetscFree(idx_act);CHKERRQ(ierr);
779d950fb63SShri Abhyankar   ierr = PetscFree(idx_inact);CHKERRQ(ierr);
780d950fb63SShri Abhyankar   PetscFunctionReturn(0);
781d950fb63SShri Abhyankar }
782d950fb63SShri Abhyankar 
783dbd914b8SShri Abhyankar /* Create active and inactive set vectors. The local size of this vector is set and petsc computes the global size */
784dbd914b8SShri Abhyankar #undef __FUNCT__
785dbd914b8SShri Abhyankar #define __FUNCT__ "SNESVICreateVectors_AS"
786dbd914b8SShri Abhyankar PetscErrorCode SNESVICreateVectors_AS(SNES snes,PetscInt n,Vec* newv)
787dbd914b8SShri Abhyankar {
788dbd914b8SShri Abhyankar   PetscErrorCode ierr;
789dbd914b8SShri Abhyankar   Vec            v;
790dbd914b8SShri Abhyankar 
791dbd914b8SShri Abhyankar   PetscFunctionBegin;
792dbd914b8SShri Abhyankar   ierr = VecCreate(((PetscObject)snes)->comm,&v);CHKERRQ(ierr);
793dbd914b8SShri Abhyankar   ierr = VecSetSizes(v,n,PETSC_DECIDE);CHKERRQ(ierr);
794dbd914b8SShri Abhyankar   ierr = VecSetFromOptions(v);CHKERRQ(ierr);
795dbd914b8SShri Abhyankar   *newv = v;
796dbd914b8SShri Abhyankar 
797dbd914b8SShri Abhyankar   PetscFunctionReturn(0);
798dbd914b8SShri Abhyankar }
799dbd914b8SShri Abhyankar 
800732bb160SShri Abhyankar /* Resets the snes PC and KSP when the active set sizes change */
801732bb160SShri Abhyankar #undef __FUNCT__
802732bb160SShri Abhyankar #define __FUNCT__ "SNESVIResetPCandKSP"
803732bb160SShri Abhyankar PetscErrorCode SNESVIResetPCandKSP(SNES snes,Mat Amat,Mat Pmat)
804732bb160SShri Abhyankar {
805732bb160SShri Abhyankar   PetscErrorCode ierr;
806732bb160SShri Abhyankar   KSP kspnew,snesksp;
807732bb160SShri Abhyankar   PC  pcnew;
808732bb160SShri Abhyankar   const MatSolverPackage stype;
809dbd914b8SShri Abhyankar 
810732bb160SShri Abhyankar   PetscFunctionBegin;
811732bb160SShri Abhyankar   /* The active and inactive set sizes have changed so need to create a new snes->ksp object */
812732bb160SShri Abhyankar   ierr = SNESGetKSP(snes,&snesksp);CHKERRQ(ierr);
813732bb160SShri Abhyankar   ierr = KSPCreate(((PetscObject)snes)->comm,&kspnew);CHKERRQ(ierr);
814732bb160SShri Abhyankar   /* Copy over snes->ksp info */
815732bb160SShri Abhyankar   kspnew->pc_side = snesksp->pc_side;
816732bb160SShri Abhyankar   kspnew->rtol    = snesksp->rtol;
817732bb160SShri Abhyankar   kspnew->abstol    = snesksp->abstol;
818732bb160SShri Abhyankar   kspnew->max_it  = snesksp->max_it;
819732bb160SShri Abhyankar   ierr = KSPSetType(kspnew,((PetscObject)snesksp)->type_name);CHKERRQ(ierr);
820732bb160SShri Abhyankar   ierr = KSPGetPC(kspnew,&pcnew);CHKERRQ(ierr);
821732bb160SShri Abhyankar   ierr = PCSetType(kspnew->pc,((PetscObject)snesksp->pc)->type_name);CHKERRQ(ierr);
822732bb160SShri Abhyankar   ierr = PCSetOperators(kspnew->pc,Amat,Pmat,DIFFERENT_NONZERO_PATTERN);CHKERRQ(ierr);
823732bb160SShri Abhyankar   ierr = PCFactorGetMatSolverPackage(snesksp->pc,&stype);CHKERRQ(ierr);
824732bb160SShri Abhyankar   ierr = PCFactorSetMatSolverPackage(kspnew->pc,stype);CHKERRQ(ierr);
825732bb160SShri Abhyankar   ierr = KSPDestroy(snesksp);CHKERRQ(ierr);
826732bb160SShri Abhyankar   snes->ksp = kspnew;
827732bb160SShri Abhyankar   ierr = PetscLogObjectParent(snes,kspnew);CHKERRQ(ierr);
828732bb160SShri Abhyankar   ierr = KSPSetFromOptions(kspnew);CHKERRQ(ierr);
829732bb160SShri Abhyankar   PetscFunctionReturn(0);
830732bb160SShri Abhyankar }
83169c03620SShri Abhyankar /* Variational Inequality solver using active set method */
83269c03620SShri Abhyankar #undef __FUNCT__
83369c03620SShri Abhyankar #define __FUNCT__ "SNESSolveVI_AS"
83469c03620SShri Abhyankar PetscErrorCode SNESSolveVI_AS(SNES snes)
83569c03620SShri Abhyankar {
83669c03620SShri Abhyankar   SNES_VI          *vi = (SNES_VI*)snes->data;
83769c03620SShri Abhyankar   PetscErrorCode     ierr;
838408da460SShri Abhyankar   PetscInt           maxits,i,lits,Nis_act=0;
8393b336b49SShri Abhyankar   PetscBool         lssucceed;
84069c03620SShri Abhyankar   MatStructure       flg = DIFFERENT_NONZERO_PATTERN;
84169c03620SShri Abhyankar   PetscReal          gnorm,xnorm=0,ynorm;
84269c03620SShri Abhyankar   Vec                Y,X,F,G,W;
84369c03620SShri Abhyankar   KSPConvergedReason kspreason;
84469c03620SShri Abhyankar 
84569c03620SShri Abhyankar   PetscFunctionBegin;
84669c03620SShri Abhyankar   snes->numFailures            = 0;
84769c03620SShri Abhyankar   snes->numLinearSolveFailures = 0;
84869c03620SShri Abhyankar   snes->reason                 = SNES_CONVERGED_ITERATING;
84969c03620SShri Abhyankar 
85069c03620SShri Abhyankar   maxits	= snes->max_its;	/* maximum number of iterations */
85169c03620SShri Abhyankar   X		= snes->vec_sol;	/* solution vector */
85269c03620SShri Abhyankar   F		= snes->vec_func;	/* residual vector */
85369c03620SShri Abhyankar   Y		= snes->work[0];	/* work vectors */
85469c03620SShri Abhyankar   G		= snes->work[1];
85569c03620SShri Abhyankar   W		= snes->work[2];
85669c03620SShri Abhyankar 
85769c03620SShri Abhyankar   ierr = PetscObjectTakeAccess(snes);CHKERRQ(ierr);
85869c03620SShri Abhyankar   snes->iter = 0;
85969c03620SShri Abhyankar   snes->norm = 0.0;
86069c03620SShri Abhyankar   ierr = PetscObjectGrantAccess(snes);CHKERRQ(ierr);
86169c03620SShri Abhyankar 
86269c03620SShri Abhyankar   ierr = SNESVIAdjustInitialGuess(X,vi->xl,vi->xu);CHKERRQ(ierr);
86369c03620SShri Abhyankar   ierr = SNESComputeFunction(snes,X,vi->phi);CHKERRQ(ierr);
86469c03620SShri Abhyankar   if (snes->domainerror) {
86569c03620SShri Abhyankar     snes->reason = SNES_DIVERGED_FUNCTION_DOMAIN;
86669c03620SShri Abhyankar     PetscFunctionReturn(0);
86769c03620SShri Abhyankar   }
86869c03620SShri Abhyankar    /* Compute Merit function */
86969c03620SShri Abhyankar   ierr = SNESVIComputeMeritFunction(vi->phi,&vi->merit,&vi->phinorm);CHKERRQ(ierr);
87069c03620SShri Abhyankar 
87169c03620SShri Abhyankar   ierr = VecNormBegin(X,NORM_2,&xnorm);CHKERRQ(ierr);	/* xnorm <- ||x||  */
87269c03620SShri Abhyankar   ierr = VecNormEnd(X,NORM_2,&xnorm);CHKERRQ(ierr);
87369c03620SShri Abhyankar   if PetscIsInfOrNanReal(vi->merit) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FP,"User provided compute function generated a Not-a-Number");
87469c03620SShri Abhyankar 
87569c03620SShri Abhyankar   ierr = PetscObjectTakeAccess(snes);CHKERRQ(ierr);
87669c03620SShri Abhyankar   snes->norm = vi->phinorm;
87769c03620SShri Abhyankar   ierr = PetscObjectGrantAccess(snes);CHKERRQ(ierr);
87869c03620SShri Abhyankar   SNESLogConvHistory(snes,vi->phinorm,0);
87969c03620SShri Abhyankar   SNESMonitor(snes,0,vi->phinorm);
88069c03620SShri Abhyankar 
88169c03620SShri Abhyankar   /* set parameter for default relative tolerance convergence test */
88269c03620SShri Abhyankar   snes->ttol = vi->phinorm*snes->rtol;
88369c03620SShri Abhyankar   /* test convergence */
88469c03620SShri Abhyankar   ierr = (*snes->ops->converged)(snes,0,0.0,0.0,vi->phinorm,&snes->reason,snes->cnvP);CHKERRQ(ierr);
88569c03620SShri Abhyankar   if (snes->reason) PetscFunctionReturn(0);
88669c03620SShri Abhyankar 
88769c03620SShri Abhyankar   for (i=0; i<maxits; i++) {
88869c03620SShri Abhyankar 
889a79edbefSShri Abhyankar     IS                 IS_act,IS_inact; /* _act -> active set _inact -> inactive set */
890a79edbefSShri Abhyankar     PetscReal          thresh,J_norm1;
891dbd914b8SShri Abhyankar     VecScatter         scat_act,scat_inact;
892408da460SShri Abhyankar     PetscInt           nis_act,nis_inact,Nis_act_prev;
893dbd914b8SShri Abhyankar     Vec                Da_act,Da_inact,Db_inact;
894dbd914b8SShri Abhyankar     Vec                Y_act,Y_inact,phi_act,phi_inact;
895d76c674bSShri Abhyankar     Mat                jac_inact_inact,jac_inact_act,prejac_inact_inact;
896a79edbefSShri Abhyankar 
89769c03620SShri Abhyankar     /* Call general purpose update function */
89869c03620SShri Abhyankar     if (snes->ops->update) {
89969c03620SShri Abhyankar       ierr = (*snes->ops->update)(snes, snes->iter);CHKERRQ(ierr);
90069c03620SShri Abhyankar     }
90169c03620SShri Abhyankar     ierr = SNESComputeJacobian(snes,X,&snes->jacobian,&snes->jacobian_pre,&flg);CHKERRQ(ierr);
90269c03620SShri Abhyankar     /* Compute the threshold value for creating active and inactive sets */
90369c03620SShri Abhyankar     ierr = MatNorm(snes->jacobian,NORM_1,&J_norm1);CHKERRQ(ierr);
90469c03620SShri Abhyankar     thresh = PetscMin(vi->merit,1e-2)/(1+J_norm1);
905a79edbefSShri Abhyankar 
906a79edbefSShri Abhyankar     /* Compute B-subdifferential vectors Da and Db */
907a79edbefSShri Abhyankar     ierr = SNESVIComputeBsubdifferentialVectors(snes,X,F,snes->jacobian,vi->Da,vi->Db);CHKERRQ(ierr);
908dbd914b8SShri Abhyankar 
90969c03620SShri Abhyankar     /* Create active and inactive index sets */
91069c03620SShri Abhyankar     ierr = SNESVICreateIndexSets_AS(snes,vi->Db,thresh,&IS_act,&IS_inact);CHKERRQ(ierr);
91169c03620SShri Abhyankar 
912408da460SShri Abhyankar     Nis_act_prev = Nis_act;
913408da460SShri Abhyankar     /* Get sizes of active and inactive sets */
914dbd914b8SShri Abhyankar     ierr = ISGetLocalSize(IS_act,&nis_act);CHKERRQ(ierr);
915dbd914b8SShri Abhyankar     ierr = ISGetLocalSize(IS_inact,&nis_inact);CHKERRQ(ierr);
916408da460SShri Abhyankar     ierr = ISGetSize(IS_act,&Nis_act);CHKERRQ(ierr);
917dbd914b8SShri Abhyankar 
918d76c674bSShri Abhyankar     ierr = PetscPrintf(PETSC_COMM_WORLD,"Size of active set = %d, size of inactive set = %d\n",nis_act,nis_inact);CHKERRQ(ierr);
919d76c674bSShri Abhyankar 
920dbd914b8SShri Abhyankar     /* Create active and inactive set vectors */
921dbd914b8SShri Abhyankar     ierr = SNESVICreateVectors_AS(snes,nis_act,&Da_act);CHKERRQ(ierr);
922dbd914b8SShri Abhyankar     ierr = SNESVICreateVectors_AS(snes,nis_inact,&Da_inact);CHKERRQ(ierr);
923dbd914b8SShri Abhyankar     ierr = SNESVICreateVectors_AS(snes,nis_inact,&Db_inact);CHKERRQ(ierr);
924dbd914b8SShri Abhyankar     ierr = SNESVICreateVectors_AS(snes,nis_act,&phi_act);CHKERRQ(ierr);
925dbd914b8SShri Abhyankar     ierr = SNESVICreateVectors_AS(snes,nis_inact,&phi_inact);CHKERRQ(ierr);
926dbd914b8SShri Abhyankar     ierr = SNESVICreateVectors_AS(snes,nis_act,&Y_act);CHKERRQ(ierr);
927dbd914b8SShri Abhyankar     ierr = SNESVICreateVectors_AS(snes,nis_inact,&Y_inact);CHKERRQ(ierr);
928dbd914b8SShri Abhyankar 
929dbd914b8SShri Abhyankar     /* Create inactive set submatrices */
930dbd914b8SShri Abhyankar     ierr = MatGetSubMatrix(snes->jacobian,IS_inact,IS_act,MAT_INITIAL_MATRIX,&jac_inact_act);CHKERRQ(ierr);
931dbd914b8SShri Abhyankar     ierr = MatGetSubMatrix(snes->jacobian,IS_inact,IS_inact,MAT_INITIAL_MATRIX,&jac_inact_inact);CHKERRQ(ierr);
932dbd914b8SShri Abhyankar 
933dbd914b8SShri Abhyankar     /* Create scatter contexts */
934dbd914b8SShri Abhyankar     ierr = VecScatterCreate(vi->Da,IS_act,Da_act,PETSC_NULL,&scat_act);CHKERRQ(ierr);
935dbd914b8SShri Abhyankar     ierr = VecScatterCreate(vi->Da,IS_inact,Da_inact,PETSC_NULL,&scat_inact);CHKERRQ(ierr);
936dbd914b8SShri Abhyankar 
937dbd914b8SShri Abhyankar     /* Do a vec scatter to active and inactive set vectors */
938dbd914b8SShri Abhyankar     ierr = VecScatterBegin(scat_act,vi->Da,Da_act,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
939dbd914b8SShri Abhyankar     ierr = VecScatterEnd(scat_act,vi->Da,Da_act,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
940dbd914b8SShri Abhyankar 
941dbd914b8SShri Abhyankar     ierr = VecScatterBegin(scat_inact,vi->Da,Da_inact,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
942dbd914b8SShri Abhyankar     ierr = VecScatterEnd(scat_inact,vi->Da,Da_inact,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
943dbd914b8SShri Abhyankar 
944dbd914b8SShri Abhyankar     ierr = VecScatterBegin(scat_inact,vi->Db,Db_inact,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
945dbd914b8SShri Abhyankar     ierr = VecScatterEnd(scat_inact,vi->Db,Db_inact,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
946dbd914b8SShri Abhyankar 
947dbd914b8SShri Abhyankar     ierr = VecScatterBegin(scat_act,vi->phi,phi_act,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
948dbd914b8SShri Abhyankar     ierr = VecScatterEnd(scat_act,vi->phi,phi_act,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
949dbd914b8SShri Abhyankar 
950dbd914b8SShri Abhyankar     ierr = VecScatterBegin(scat_inact,vi->phi,phi_inact,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
951dbd914b8SShri Abhyankar     ierr = VecScatterEnd(scat_inact,vi->phi,phi_inact,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
952dbd914b8SShri Abhyankar 
953dbd914b8SShri Abhyankar     ierr = VecScatterBegin(scat_act,Y,Y_act,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
954dbd914b8SShri Abhyankar     ierr = VecScatterEnd(scat_act,Y,Y_act,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
955dbd914b8SShri Abhyankar 
956dbd914b8SShri Abhyankar     ierr = VecScatterBegin(scat_inact,Y,Y_inact,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
957dbd914b8SShri Abhyankar     ierr = VecScatterEnd(scat_inact,Y,Y_inact,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
958dbd914b8SShri Abhyankar 
959dbd914b8SShri Abhyankar     /* Active set direction */
960dbd914b8SShri Abhyankar     ierr = VecPointwiseDivide(Y_act,phi_act,Da_act);CHKERRQ(ierr);
961d76c674bSShri Abhyankar     /* inactive set jacobian and preconditioner */
962dbd914b8SShri Abhyankar     ierr = VecPointwiseDivide(Da_inact,Da_inact,Db_inact);CHKERRQ(ierr);
963dbd914b8SShri Abhyankar     ierr = MatDiagonalSet(jac_inact_inact,Da_inact,ADD_VALUES);CHKERRQ(ierr);
964d76c674bSShri Abhyankar     if (snes->jacobian != snes->jacobian_pre) {
965d76c674bSShri Abhyankar       ierr = MatGetSubMatrix(snes->jacobian_pre,IS_inact,IS_inact,MAT_INITIAL_MATRIX,&prejac_inact_inact);CHKERRQ(ierr);
966d76c674bSShri Abhyankar       ierr = MatDiagonalSet(prejac_inact_inact,Da_inact,ADD_VALUES);CHKERRQ(ierr);
967d76c674bSShri Abhyankar     } else prejac_inact_inact = jac_inact_inact;
968d76c674bSShri Abhyankar 
969dbd914b8SShri Abhyankar     /* right hand side */
970dbd914b8SShri Abhyankar     ierr = VecPointwiseDivide(phi_inact,phi_inact,Db_inact);CHKERRQ(ierr);
971dbd914b8SShri Abhyankar     ierr = MatMult(jac_inact_act,Y_act,Db_inact);CHKERRQ(ierr);
972dbd914b8SShri Abhyankar     ierr = VecAXPY(phi_inact,-1.0,Db_inact);CHKERRQ(ierr);
973dbd914b8SShri Abhyankar 
974408da460SShri Abhyankar     if ((i != 0) && (Nis_act != Nis_act_prev)) {
975732bb160SShri Abhyankar       ierr = SNESVIResetPCandKSP(snes,jac_inact_inact,prejac_inact_inact);CHKERRQ(ierr);
976408da460SShri Abhyankar     }
977408da460SShri Abhyankar 
978d76c674bSShri Abhyankar     ierr = KSPSetOperators(snes->ksp,jac_inact_inact,prejac_inact_inact,flg);CHKERRQ(ierr);
979dbd914b8SShri Abhyankar     ierr = SNES_KSPSolve(snes,snes->ksp,phi_inact,Y_inact);CHKERRQ(ierr);
980dbd914b8SShri Abhyankar     ierr = KSPGetConvergedReason(snes->ksp,&kspreason);CHKERRQ(ierr);
9813b336b49SShri Abhyankar     if (kspreason < 0) {
9823b336b49SShri Abhyankar       if (++snes->numLinearSolveFailures >= snes->maxLinearSolveFailures) {
9833b336b49SShri 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);
9843b336b49SShri Abhyankar         snes->reason = SNES_DIVERGED_LINEAR_SOLVE;
9853b336b49SShri Abhyankar         break;
9863b336b49SShri Abhyankar       }
9873b336b49SShri Abhyankar      }
988dbd914b8SShri Abhyankar 
989dbd914b8SShri Abhyankar     ierr = VecScatterBegin(scat_act,Y_act,Y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
990dbd914b8SShri Abhyankar     ierr = VecScatterEnd(scat_act,Y_act,Y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
991dbd914b8SShri Abhyankar     ierr = VecScatterBegin(scat_inact,Y_inact,Y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
992dbd914b8SShri Abhyankar     ierr = VecScatterEnd(scat_inact,Y_inact,Y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
993dbd914b8SShri Abhyankar 
994dbd914b8SShri Abhyankar     ierr = VecDestroy(Da_act);CHKERRQ(ierr);
995dbd914b8SShri Abhyankar     ierr = VecDestroy(Da_inact);CHKERRQ(ierr);
996dbd914b8SShri Abhyankar     ierr = VecDestroy(Db_inact);CHKERRQ(ierr);
997dbd914b8SShri Abhyankar     ierr = VecDestroy(phi_act);CHKERRQ(ierr);
998dbd914b8SShri Abhyankar     ierr = VecDestroy(phi_inact);CHKERRQ(ierr);
999dbd914b8SShri Abhyankar     ierr = VecDestroy(Y_act);CHKERRQ(ierr);
1000dbd914b8SShri Abhyankar     ierr = VecDestroy(Y_inact);CHKERRQ(ierr);
1001dbd914b8SShri Abhyankar     ierr = VecScatterDestroy(scat_act);CHKERRQ(ierr);
1002dbd914b8SShri Abhyankar     ierr = VecScatterDestroy(scat_inact);CHKERRQ(ierr);
1003730c24dcSShri Abhyankar     ierr = ISDestroy(IS_act);CHKERRQ(ierr);
1004730c24dcSShri Abhyankar     ierr = ISDestroy(IS_inact);CHKERRQ(ierr);
1005bac2f86eSShri Abhyankar     ierr = MatDestroy(jac_inact_act);CHKERRQ(ierr);
1006bac2f86eSShri Abhyankar     ierr = MatDestroy(jac_inact_inact);CHKERRQ(ierr);
1007d76c674bSShri Abhyankar     if (snes->jacobian != snes->jacobian_pre) {
1008d76c674bSShri Abhyankar       ierr = MatDestroy(prejac_inact_inact);CHKERRQ(ierr);
1009d76c674bSShri Abhyankar     }
1010730c24dcSShri Abhyankar 
101169c03620SShri Abhyankar     ierr = KSPGetIterationNumber(snes->ksp,&lits);CHKERRQ(ierr);
101269c03620SShri Abhyankar     snes->linear_its += lits;
101369c03620SShri Abhyankar     ierr = PetscInfo2(snes,"iter=%D, linear solve iterations=%D\n",snes->iter,lits);CHKERRQ(ierr);
101469c03620SShri Abhyankar     /*
101569c03620SShri Abhyankar     if (vi->precheckstep) {
101669c03620SShri Abhyankar       PetscBool changed_y = PETSC_FALSE;
101769c03620SShri Abhyankar       ierr = (*vi->precheckstep)(snes,X,Y,vi->precheck,&changed_y);CHKERRQ(ierr);
101869c03620SShri Abhyankar     }
101969c03620SShri Abhyankar 
102069c03620SShri Abhyankar     if (PetscLogPrintInfo){
102169c03620SShri Abhyankar       ierr = SNESVICheckResidual_Private(snes,snes->jacobian,F,Y,G,W);CHKERRQ(ierr);
102269c03620SShri Abhyankar     }
102369c03620SShri Abhyankar     */
102469c03620SShri Abhyankar     /* Compute a (scaled) negative update in the line search routine:
102569c03620SShri Abhyankar          Y <- X - lambda*Y
102669c03620SShri Abhyankar        and evaluate G = function(Y) (depends on the line search).
102769c03620SShri Abhyankar     */
102869c03620SShri Abhyankar     ierr = VecCopy(Y,snes->vec_sol_update);CHKERRQ(ierr);
102969c03620SShri Abhyankar     ynorm = 1; gnorm = vi->phinorm;
10303b336b49SShri Abhyankar     ierr = SNESVIComputeJacobian(snes->jacobian,snes->jacobian_pre,vi->Da,vi->Db);CHKERRQ(ierr);
1031ee657d29SShri Abhyankar     ierr = SNESVIComputeMeritFunctionGradient(snes->jacobian,vi->phi,vi->dpsi);CHKERRQ(ierr);
103269c03620SShri Abhyankar     ierr = (*vi->LineSearch)(snes,vi->lsP,X,vi->phi,G,Y,W,vi->phinorm,xnorm,&ynorm,&gnorm,&lssucceed);CHKERRQ(ierr);
103369c03620SShri Abhyankar     ierr = PetscInfo4(snes,"fnorm=%18.16e, gnorm=%18.16e, ynorm=%18.16e, lssucceed=%d\n",vi->phinorm,gnorm,ynorm,(int)lssucceed);CHKERRQ(ierr);
103469c03620SShri Abhyankar     if (snes->reason == SNES_DIVERGED_FUNCTION_COUNT) break;
103569c03620SShri Abhyankar     if (snes->domainerror) {
103669c03620SShri Abhyankar       snes->reason = SNES_DIVERGED_FUNCTION_DOMAIN;
103769c03620SShri Abhyankar       PetscFunctionReturn(0);
103869c03620SShri Abhyankar     }
103969c03620SShri Abhyankar     if (!lssucceed) {
104069c03620SShri Abhyankar       if (++snes->numFailures >= snes->maxFailures) {
104169c03620SShri Abhyankar 	PetscBool ismin;
104269c03620SShri Abhyankar         snes->reason = SNES_DIVERGED_LINE_SEARCH;
104369c03620SShri Abhyankar         ierr = SNESVICheckLocalMin_Private(snes,snes->jacobian,G,W,gnorm,&ismin);CHKERRQ(ierr);
104469c03620SShri Abhyankar         if (ismin) snes->reason = SNES_DIVERGED_LOCAL_MIN;
104569c03620SShri Abhyankar         break;
104669c03620SShri Abhyankar       }
104769c03620SShri Abhyankar     }
104869c03620SShri Abhyankar     /* Update function and solution vectors */
104969c03620SShri Abhyankar     vi->phinorm = gnorm;
105069c03620SShri Abhyankar     vi->merit = 0.5*vi->phinorm*vi->phinorm;
105169c03620SShri Abhyankar     ierr = VecCopy(G,vi->phi);CHKERRQ(ierr);
105269c03620SShri Abhyankar     ierr = VecCopy(W,X);CHKERRQ(ierr);
105369c03620SShri Abhyankar     /* Monitor convergence */
105469c03620SShri Abhyankar     ierr = PetscObjectTakeAccess(snes);CHKERRQ(ierr);
105569c03620SShri Abhyankar     snes->iter = i+1;
105669c03620SShri Abhyankar     snes->norm = vi->phinorm;
105769c03620SShri Abhyankar     ierr = PetscObjectGrantAccess(snes);CHKERRQ(ierr);
105869c03620SShri Abhyankar     SNESLogConvHistory(snes,snes->norm,lits);
105969c03620SShri Abhyankar     SNESMonitor(snes,snes->iter,snes->norm);
106069c03620SShri Abhyankar     /* Test for convergence, xnorm = || X || */
106169c03620SShri Abhyankar     if (snes->ops->converged != SNESSkipConverged) { ierr = VecNorm(X,NORM_2,&xnorm);CHKERRQ(ierr); }
106269c03620SShri Abhyankar     ierr = (*snes->ops->converged)(snes,snes->iter,xnorm,ynorm,vi->phinorm,&snes->reason,snes->cnvP);CHKERRQ(ierr);
106369c03620SShri Abhyankar     if (snes->reason) break;
106469c03620SShri Abhyankar   }
106569c03620SShri Abhyankar   if (i == maxits) {
106669c03620SShri Abhyankar     ierr = PetscInfo1(snes,"Maximum number of iterations has been reached: %D\n",maxits);CHKERRQ(ierr);
106769c03620SShri Abhyankar     if(!snes->reason) snes->reason = SNES_DIVERGED_MAX_IT;
106869c03620SShri Abhyankar   }
106969c03620SShri Abhyankar   PetscFunctionReturn(0);
107069c03620SShri Abhyankar }
107169c03620SShri Abhyankar 
1072d950fb63SShri Abhyankar /* Variational Inequality solver using active set method */
1073d950fb63SShri Abhyankar #undef __FUNCT__
1074d950fb63SShri Abhyankar #define __FUNCT__ "SNESSolveVI_RS"
1075d950fb63SShri Abhyankar PetscErrorCode SNESSolveVI_RS(SNES snes)
1076d950fb63SShri Abhyankar {
1077d950fb63SShri Abhyankar   SNES_VI          *vi = (SNES_VI*)snes->data;
1078d950fb63SShri Abhyankar   PetscErrorCode     ierr;
1079d950fb63SShri Abhyankar   PetscInt           maxits,i,lits,Nis_act=0;
1080d950fb63SShri Abhyankar   PetscBool         lssucceed;
1081d950fb63SShri Abhyankar   MatStructure       flg = DIFFERENT_NONZERO_PATTERN;
1082d950fb63SShri Abhyankar   PetscReal          gnorm,xnorm=0,ynorm;
1083d950fb63SShri Abhyankar   Vec                Y,X,F,G,W;
1084d950fb63SShri Abhyankar   KSPConvergedReason kspreason;
1085d950fb63SShri Abhyankar 
1086d950fb63SShri Abhyankar   PetscFunctionBegin;
1087d950fb63SShri Abhyankar   snes->numFailures            = 0;
1088d950fb63SShri Abhyankar   snes->numLinearSolveFailures = 0;
1089d950fb63SShri Abhyankar   snes->reason                 = SNES_CONVERGED_ITERATING;
1090d950fb63SShri Abhyankar 
1091d950fb63SShri Abhyankar   maxits	= snes->max_its;	/* maximum number of iterations */
1092d950fb63SShri Abhyankar   X		= snes->vec_sol;	/* solution vector */
1093d950fb63SShri Abhyankar   F		= snes->vec_func;	/* residual vector */
1094d950fb63SShri Abhyankar   Y		= snes->work[0];	/* work vectors */
1095d950fb63SShri Abhyankar   G		= snes->work[1];
1096d950fb63SShri Abhyankar   W		= snes->work[2];
1097d950fb63SShri Abhyankar 
1098d950fb63SShri Abhyankar   ierr = PetscObjectTakeAccess(snes);CHKERRQ(ierr);
1099d950fb63SShri Abhyankar   snes->iter = 0;
1100d950fb63SShri Abhyankar   snes->norm = 0.0;
1101d950fb63SShri Abhyankar   ierr = PetscObjectGrantAccess(snes);CHKERRQ(ierr);
1102d950fb63SShri Abhyankar 
1103d950fb63SShri Abhyankar   ierr = SNESVIAdjustInitialGuess(X,vi->xl,vi->xu);CHKERRQ(ierr);
1104d950fb63SShri Abhyankar   ierr = SNESComputeFunction(snes,X,vi->phi);CHKERRQ(ierr);
1105d950fb63SShri Abhyankar   if (snes->domainerror) {
1106d950fb63SShri Abhyankar     snes->reason = SNES_DIVERGED_FUNCTION_DOMAIN;
1107d950fb63SShri Abhyankar     PetscFunctionReturn(0);
1108d950fb63SShri Abhyankar   }
1109d950fb63SShri Abhyankar    /* Compute Merit function */
1110d950fb63SShri Abhyankar   ierr = SNESVIComputeMeritFunction(vi->phi,&vi->merit,&vi->phinorm);CHKERRQ(ierr);
1111d950fb63SShri Abhyankar 
1112d950fb63SShri Abhyankar   ierr = VecNormBegin(X,NORM_2,&xnorm);CHKERRQ(ierr);	/* xnorm <- ||x||  */
1113d950fb63SShri Abhyankar   ierr = VecNormEnd(X,NORM_2,&xnorm);CHKERRQ(ierr);
1114d950fb63SShri Abhyankar   if PetscIsInfOrNanReal(vi->merit) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FP,"User provided compute function generated a Not-a-Number");
1115d950fb63SShri Abhyankar 
1116d950fb63SShri Abhyankar   ierr = PetscObjectTakeAccess(snes);CHKERRQ(ierr);
1117d950fb63SShri Abhyankar   snes->norm = vi->phinorm;
1118d950fb63SShri Abhyankar   ierr = PetscObjectGrantAccess(snes);CHKERRQ(ierr);
1119d950fb63SShri Abhyankar   SNESLogConvHistory(snes,vi->phinorm,0);
1120d950fb63SShri Abhyankar   SNESMonitor(snes,0,vi->phinorm);
1121d950fb63SShri Abhyankar 
1122d950fb63SShri Abhyankar   /* set parameter for default relative tolerance convergence test */
1123d950fb63SShri Abhyankar   snes->ttol = vi->phinorm*snes->rtol;
1124d950fb63SShri Abhyankar   /* test convergence */
1125d950fb63SShri Abhyankar   ierr = (*snes->ops->converged)(snes,0,0.0,0.0,vi->phinorm,&snes->reason,snes->cnvP);CHKERRQ(ierr);
1126d950fb63SShri Abhyankar   if (snes->reason) PetscFunctionReturn(0);
1127d950fb63SShri Abhyankar 
1128d950fb63SShri Abhyankar   for (i=0; i<maxits; i++) {
1129d950fb63SShri Abhyankar 
1130d950fb63SShri Abhyankar     IS                 IS_act,IS_inact; /* _act -> active set _inact -> inactive set */
1131d950fb63SShri Abhyankar     VecScatter         scat_act,scat_inact;
1132d950fb63SShri Abhyankar     PetscInt           nis_act,nis_inact,Nis_act_prev;
1133d950fb63SShri Abhyankar     Vec                Y_act,Y_inact,phi_inact;
1134d950fb63SShri Abhyankar     Mat                jac_inact_inact,prejac_inact_inact;
1135d950fb63SShri Abhyankar 
1136d950fb63SShri Abhyankar     /* Call general purpose update function */
1137d950fb63SShri Abhyankar     if (snes->ops->update) {
1138d950fb63SShri Abhyankar       ierr = (*snes->ops->update)(snes, snes->iter);CHKERRQ(ierr);
1139d950fb63SShri Abhyankar     }
1140d950fb63SShri Abhyankar     ierr = SNESComputeJacobian(snes,X,&snes->jacobian,&snes->jacobian_pre,&flg);CHKERRQ(ierr);
1141d950fb63SShri Abhyankar     ierr = SNESVIComputeBsubdifferentialVectors(snes,X,F,snes->jacobian,vi->Da,vi->Db);CHKERRQ(ierr);
1142d950fb63SShri Abhyankar     ierr = SNESVIComputeJacobian(snes->jacobian,snes->jacobian_pre,vi->Da,vi->Db);CHKERRQ(ierr);
1143ee657d29SShri Abhyankar     ierr = SNESVIComputeMeritFunctionGradient(snes->jacobian,vi->phi,vi->dpsi);CHKERRQ(ierr);
1144d950fb63SShri Abhyankar     /* Create active and inactive index sets */
1145d950fb63SShri Abhyankar     ierr = SNESVICreateIndexSets_RS(snes,X,vi->xl,vi->xu,&IS_act,&IS_inact);CHKERRQ(ierr);
1146d950fb63SShri Abhyankar 
1147d950fb63SShri Abhyankar     Nis_act_prev = Nis_act;
1148d950fb63SShri Abhyankar     /* Get sizes of active and inactive sets */
1149d950fb63SShri Abhyankar     ierr = ISGetLocalSize(IS_act,&nis_act);CHKERRQ(ierr);
1150d950fb63SShri Abhyankar     ierr = ISGetLocalSize(IS_inact,&nis_inact);CHKERRQ(ierr);
1151d950fb63SShri Abhyankar     ierr = ISGetSize(IS_act,&Nis_act);CHKERRQ(ierr);
1152d950fb63SShri Abhyankar 
1153d950fb63SShri Abhyankar     ierr = PetscPrintf(PETSC_COMM_WORLD,"Size of active set = %d, size of inactive set = %d\n",nis_act,nis_inact);CHKERRQ(ierr);
1154d950fb63SShri Abhyankar 
1155d950fb63SShri Abhyankar     /* Create active and inactive set vectors */
1156d950fb63SShri Abhyankar     ierr = SNESVICreateVectors_AS(snes,nis_inact,&phi_inact);CHKERRQ(ierr);
1157d950fb63SShri Abhyankar     ierr = SNESVICreateVectors_AS(snes,nis_act,&Y_act);CHKERRQ(ierr);
1158d950fb63SShri Abhyankar     ierr = SNESVICreateVectors_AS(snes,nis_inact,&Y_inact);CHKERRQ(ierr);
1159d950fb63SShri Abhyankar 
1160d950fb63SShri Abhyankar     /* Create inactive set submatrices */
1161d950fb63SShri Abhyankar     ierr = MatGetSubMatrix(snes->jacobian,IS_inact,IS_inact,MAT_INITIAL_MATRIX,&jac_inact_inact);CHKERRQ(ierr);
1162d950fb63SShri Abhyankar 
1163d950fb63SShri Abhyankar     /* Create scatter contexts */
1164d950fb63SShri Abhyankar     ierr = VecScatterCreate(Y,IS_act,Y_act,PETSC_NULL,&scat_act);CHKERRQ(ierr);
1165d950fb63SShri Abhyankar     ierr = VecScatterCreate(Y,IS_inact,Y_inact,PETSC_NULL,&scat_inact);CHKERRQ(ierr);
1166d950fb63SShri Abhyankar 
1167d950fb63SShri Abhyankar     /* Do a vec scatter to active and inactive set vectors */
1168d950fb63SShri Abhyankar     ierr = VecScatterBegin(scat_inact,vi->phi,phi_inact,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1169d950fb63SShri Abhyankar     ierr = VecScatterEnd(scat_inact,vi->phi,phi_inact,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1170d950fb63SShri Abhyankar 
1171d950fb63SShri Abhyankar     ierr = VecScatterBegin(scat_act,Y,Y_act,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1172d950fb63SShri Abhyankar     ierr = VecScatterEnd(scat_act,Y,Y_act,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1173d950fb63SShri Abhyankar 
1174d950fb63SShri Abhyankar     ierr = VecScatterBegin(scat_inact,Y,Y_inact,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1175d950fb63SShri Abhyankar     ierr = VecScatterEnd(scat_inact,Y,Y_inact,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1176d950fb63SShri Abhyankar 
1177d950fb63SShri Abhyankar     /* Active set direction = 0*/
1178d950fb63SShri Abhyankar     ierr = VecSet(Y_act,0);CHKERRQ(ierr);
1179d950fb63SShri Abhyankar     if (snes->jacobian != snes->jacobian_pre) {
1180d950fb63SShri Abhyankar       ierr = MatGetSubMatrix(snes->jacobian_pre,IS_inact,IS_inact,MAT_INITIAL_MATRIX,&prejac_inact_inact);CHKERRQ(ierr);
1181d950fb63SShri Abhyankar     } else prejac_inact_inact = jac_inact_inact;
1182d950fb63SShri Abhyankar 
1183d950fb63SShri Abhyankar     if ((i != 0) && (Nis_act != Nis_act_prev)) {
1184732bb160SShri Abhyankar       ierr = SNESVIResetPCandKSP(snes,jac_inact_inact,prejac_inact_inact);CHKERRQ(ierr);
1185d950fb63SShri Abhyankar     }
1186d950fb63SShri Abhyankar 
1187d950fb63SShri Abhyankar     ierr = KSPSetOperators(snes->ksp,jac_inact_inact,prejac_inact_inact,flg);CHKERRQ(ierr);
1188d950fb63SShri Abhyankar     ierr = SNES_KSPSolve(snes,snes->ksp,phi_inact,Y_inact);CHKERRQ(ierr);
1189d950fb63SShri Abhyankar     ierr = KSPGetConvergedReason(snes->ksp,&kspreason);CHKERRQ(ierr);
1190d950fb63SShri Abhyankar     if (kspreason < 0) {
1191d950fb63SShri Abhyankar       if (++snes->numLinearSolveFailures >= snes->maxLinearSolveFailures) {
1192d950fb63SShri 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);
1193d950fb63SShri Abhyankar         snes->reason = SNES_DIVERGED_LINEAR_SOLVE;
1194d950fb63SShri Abhyankar         break;
1195d950fb63SShri Abhyankar       }
1196d950fb63SShri Abhyankar      }
1197d950fb63SShri Abhyankar 
1198d950fb63SShri Abhyankar     ierr = VecScatterBegin(scat_act,Y_act,Y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1199d950fb63SShri Abhyankar     ierr = VecScatterEnd(scat_act,Y_act,Y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1200d950fb63SShri Abhyankar     ierr = VecScatterBegin(scat_inact,Y_inact,Y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1201d950fb63SShri Abhyankar     ierr = VecScatterEnd(scat_inact,Y_inact,Y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1202d950fb63SShri Abhyankar 
1203d950fb63SShri Abhyankar     ierr = VecDestroy(phi_inact);CHKERRQ(ierr);
1204d950fb63SShri Abhyankar     ierr = VecDestroy(Y_act);CHKERRQ(ierr);
1205d950fb63SShri Abhyankar     ierr = VecDestroy(Y_inact);CHKERRQ(ierr);
1206d950fb63SShri Abhyankar     ierr = VecScatterDestroy(scat_act);CHKERRQ(ierr);
1207d950fb63SShri Abhyankar     ierr = VecScatterDestroy(scat_inact);CHKERRQ(ierr);
1208d950fb63SShri Abhyankar     ierr = ISDestroy(IS_act);CHKERRQ(ierr);
1209d950fb63SShri Abhyankar     ierr = ISDestroy(IS_inact);CHKERRQ(ierr);
1210d950fb63SShri Abhyankar     ierr = MatDestroy(jac_inact_inact);CHKERRQ(ierr);
1211d950fb63SShri Abhyankar     if (snes->jacobian != snes->jacobian_pre) {
1212d950fb63SShri Abhyankar       ierr = MatDestroy(prejac_inact_inact);CHKERRQ(ierr);
1213d950fb63SShri Abhyankar     }
1214d950fb63SShri Abhyankar 
1215d950fb63SShri Abhyankar     ierr = KSPGetIterationNumber(snes->ksp,&lits);CHKERRQ(ierr);
1216d950fb63SShri Abhyankar     snes->linear_its += lits;
1217d950fb63SShri Abhyankar     ierr = PetscInfo2(snes,"iter=%D, linear solve iterations=%D\n",snes->iter,lits);CHKERRQ(ierr);
1218d950fb63SShri Abhyankar     /*
1219d950fb63SShri Abhyankar     if (vi->precheckstep) {
1220d950fb63SShri Abhyankar       PetscBool changed_y = PETSC_FALSE;
1221d950fb63SShri Abhyankar       ierr = (*vi->precheckstep)(snes,X,Y,vi->precheck,&changed_y);CHKERRQ(ierr);
1222d950fb63SShri Abhyankar     }
1223d950fb63SShri Abhyankar 
1224d950fb63SShri Abhyankar     if (PetscLogPrintInfo){
1225d950fb63SShri Abhyankar       ierr = SNESVICheckResidual_Private(snes,snes->jacobian,F,Y,G,W);CHKERRQ(ierr);
1226d950fb63SShri Abhyankar     }
1227d950fb63SShri Abhyankar     */
1228d950fb63SShri Abhyankar     /* Compute a (scaled) negative update in the line search routine:
1229d950fb63SShri Abhyankar          Y <- X - lambda*Y
1230d950fb63SShri Abhyankar        and evaluate G = function(Y) (depends on the line search).
1231d950fb63SShri Abhyankar     */
1232d950fb63SShri Abhyankar     ierr = VecCopy(Y,snes->vec_sol_update);CHKERRQ(ierr);
1233d950fb63SShri Abhyankar     ynorm = 1; gnorm = vi->phinorm;
12342b4ed282SShri Abhyankar     ierr = (*vi->LineSearch)(snes,vi->lsP,X,vi->phi,G,Y,W,vi->phinorm,xnorm,&ynorm,&gnorm,&lssucceed);CHKERRQ(ierr);
12352b4ed282SShri Abhyankar     ierr = PetscInfo4(snes,"fnorm=%18.16e, gnorm=%18.16e, ynorm=%18.16e, lssucceed=%d\n",vi->phinorm,gnorm,ynorm,(int)lssucceed);CHKERRQ(ierr);
12362b4ed282SShri Abhyankar     if (snes->reason == SNES_DIVERGED_FUNCTION_COUNT) break;
12372b4ed282SShri Abhyankar     if (snes->domainerror) {
12382b4ed282SShri Abhyankar       snes->reason = SNES_DIVERGED_FUNCTION_DOMAIN;
12392b4ed282SShri Abhyankar       PetscFunctionReturn(0);
12402b4ed282SShri Abhyankar     }
12412b4ed282SShri Abhyankar     if (!lssucceed) {
12422b4ed282SShri Abhyankar       if (++snes->numFailures >= snes->maxFailures) {
12432b4ed282SShri Abhyankar 	PetscBool ismin;
12442b4ed282SShri Abhyankar         snes->reason = SNES_DIVERGED_LINE_SEARCH;
12452b4ed282SShri Abhyankar         ierr = SNESVICheckLocalMin_Private(snes,snes->jacobian,G,W,gnorm,&ismin);CHKERRQ(ierr);
12462b4ed282SShri Abhyankar         if (ismin) snes->reason = SNES_DIVERGED_LOCAL_MIN;
12472b4ed282SShri Abhyankar         break;
12482b4ed282SShri Abhyankar       }
12492b4ed282SShri Abhyankar     }
12502b4ed282SShri Abhyankar     /* Update function and solution vectors */
12512b4ed282SShri Abhyankar     vi->phinorm = gnorm;
12522b4ed282SShri Abhyankar     vi->merit = 0.5*vi->phinorm*vi->phinorm;
12532b4ed282SShri Abhyankar     ierr = VecCopy(G,vi->phi);CHKERRQ(ierr);
12542b4ed282SShri Abhyankar     ierr = VecCopy(W,X);CHKERRQ(ierr);
12552b4ed282SShri Abhyankar     /* Monitor convergence */
12562b4ed282SShri Abhyankar     ierr = PetscObjectTakeAccess(snes);CHKERRQ(ierr);
12572b4ed282SShri Abhyankar     snes->iter = i+1;
12582b4ed282SShri Abhyankar     snes->norm = vi->phinorm;
12592b4ed282SShri Abhyankar     ierr = PetscObjectGrantAccess(snes);CHKERRQ(ierr);
12602b4ed282SShri Abhyankar     SNESLogConvHistory(snes,snes->norm,lits);
12612b4ed282SShri Abhyankar     SNESMonitor(snes,snes->iter,snes->norm);
12622b4ed282SShri Abhyankar     /* Test for convergence, xnorm = || X || */
12632b4ed282SShri Abhyankar     if (snes->ops->converged != SNESSkipConverged) { ierr = VecNorm(X,NORM_2,&xnorm);CHKERRQ(ierr); }
12642b4ed282SShri Abhyankar     ierr = (*snes->ops->converged)(snes,snes->iter,xnorm,ynorm,vi->phinorm,&snes->reason,snes->cnvP);CHKERRQ(ierr);
12652b4ed282SShri Abhyankar     if (snes->reason) break;
12662b4ed282SShri Abhyankar   }
12672b4ed282SShri Abhyankar   if (i == maxits) {
12682b4ed282SShri Abhyankar     ierr = PetscInfo1(snes,"Maximum number of iterations has been reached: %D\n",maxits);CHKERRQ(ierr);
12692b4ed282SShri Abhyankar     if(!snes->reason) snes->reason = SNES_DIVERGED_MAX_IT;
12702b4ed282SShri Abhyankar   }
12712b4ed282SShri Abhyankar   PetscFunctionReturn(0);
12722b4ed282SShri Abhyankar }
12732b4ed282SShri Abhyankar 
12742b4ed282SShri Abhyankar /* -------------------------------------------------------------------------- */
12752b4ed282SShri Abhyankar /*
12762b4ed282SShri Abhyankar    SNESSetUp_VI - Sets up the internal data structures for the later use
12772b4ed282SShri Abhyankar    of the SNESVI nonlinear solver.
12782b4ed282SShri Abhyankar 
12792b4ed282SShri Abhyankar    Input Parameter:
12802b4ed282SShri Abhyankar .  snes - the SNES context
12812b4ed282SShri Abhyankar .  x - the solution vector
12822b4ed282SShri Abhyankar 
12832b4ed282SShri Abhyankar    Application Interface Routine: SNESSetUp()
12842b4ed282SShri Abhyankar 
12852b4ed282SShri Abhyankar    Notes:
12862b4ed282SShri Abhyankar    For basic use of the SNES solvers, the user need not explicitly call
12872b4ed282SShri Abhyankar    SNESSetUp(), since these actions will automatically occur during
12882b4ed282SShri Abhyankar    the call to SNESSolve().
12892b4ed282SShri Abhyankar  */
12902b4ed282SShri Abhyankar #undef __FUNCT__
12912b4ed282SShri Abhyankar #define __FUNCT__ "SNESSetUp_VI"
12922b4ed282SShri Abhyankar PetscErrorCode SNESSetUp_VI(SNES snes)
12932b4ed282SShri Abhyankar {
12942b4ed282SShri Abhyankar   PetscErrorCode ierr;
12952b4ed282SShri Abhyankar   SNES_VI      *vi = (SNES_VI*) snes->data;
12962b4ed282SShri Abhyankar   PetscInt       i_start[3],i_end[3];
12972b4ed282SShri Abhyankar 
12982b4ed282SShri Abhyankar   PetscFunctionBegin;
12992b4ed282SShri Abhyankar   if (!snes->vec_sol_update) {
13002b4ed282SShri Abhyankar     ierr = VecDuplicate(snes->vec_sol,&snes->vec_sol_update);CHKERRQ(ierr);
13012b4ed282SShri Abhyankar     ierr = PetscLogObjectParent(snes,snes->vec_sol_update);CHKERRQ(ierr);
13022b4ed282SShri Abhyankar   }
13032b4ed282SShri Abhyankar   if (!snes->work) {
13042b4ed282SShri Abhyankar     snes->nwork = 3;
13052b4ed282SShri Abhyankar     ierr = VecDuplicateVecs(snes->vec_sol,snes->nwork,&snes->work);CHKERRQ(ierr);
13062b4ed282SShri Abhyankar     ierr = PetscLogObjectParents(snes,snes->nwork,snes->work);CHKERRQ(ierr);
13072b4ed282SShri Abhyankar   }
1308ee657d29SShri Abhyankar   ierr = VecDuplicate(snes->vec_sol, &vi->dpsi);CHKERRQ(ierr);
13092b4ed282SShri Abhyankar   ierr = VecDuplicate(snes->vec_sol, &vi->phi); CHKERRQ(ierr);
13102b4ed282SShri Abhyankar   ierr = VecDuplicate(snes->vec_sol, &vi->Da); CHKERRQ(ierr);
13112b4ed282SShri Abhyankar   ierr = VecDuplicate(snes->vec_sol, &vi->Db); CHKERRQ(ierr);
13122b4ed282SShri Abhyankar   ierr = VecDuplicate(snes->vec_sol, &vi->z);CHKERRQ(ierr);
13132b4ed282SShri Abhyankar   ierr = VecDuplicate(snes->vec_sol, &vi->t); CHKERRQ(ierr);
13142b4ed282SShri Abhyankar 
13152b4ed282SShri Abhyankar   /* If the lower and upper bound on variables are not set, set it to
13162b4ed282SShri Abhyankar      -Inf and Inf */
13172b4ed282SShri Abhyankar   if (!vi->xl && !vi->xu) {
13182b4ed282SShri Abhyankar     vi->usersetxbounds = PETSC_FALSE;
13192b4ed282SShri Abhyankar     ierr = VecDuplicate(snes->vec_sol, &vi->xl); CHKERRQ(ierr);
13202b4ed282SShri Abhyankar     ierr = VecSet(vi->xl,PETSC_VI_NINF);CHKERRQ(ierr);
13212b4ed282SShri Abhyankar     ierr = VecDuplicate(snes->vec_sol, &vi->xu); CHKERRQ(ierr);
13222b4ed282SShri Abhyankar     ierr = VecSet(vi->xu,PETSC_VI_INF);CHKERRQ(ierr);
13232b4ed282SShri Abhyankar   } else {
13242b4ed282SShri Abhyankar     /* Check if lower bound, upper bound and solution vector distribution across the processors is identical */
13252b4ed282SShri Abhyankar     ierr = VecGetOwnershipRange(snes->vec_sol,i_start,i_end);CHKERRQ(ierr);
13262b4ed282SShri Abhyankar     ierr = VecGetOwnershipRange(vi->xl,i_start+1,i_end+1);CHKERRQ(ierr);
13272b4ed282SShri Abhyankar     ierr = VecGetOwnershipRange(vi->xu,i_start+2,i_end+2);CHKERRQ(ierr);
13282b4ed282SShri 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]))
13292b4ed282SShri 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.");
13302b4ed282SShri Abhyankar   }
13312b4ed282SShri Abhyankar 
13322b4ed282SShri Abhyankar   vi->computeuserfunction = snes->ops->computefunction;
13331f79c099SShri Abhyankar   snes->ops->computefunction = SNESVIComputeFunction;
1334a79edbefSShri Abhyankar 
13352b4ed282SShri Abhyankar   PetscFunctionReturn(0);
13362b4ed282SShri Abhyankar }
13372b4ed282SShri Abhyankar /* -------------------------------------------------------------------------- */
13382b4ed282SShri Abhyankar /*
13392b4ed282SShri Abhyankar    SNESDestroy_VI - Destroys the private SNES_VI context that was created
13402b4ed282SShri Abhyankar    with SNESCreate_VI().
13412b4ed282SShri Abhyankar 
13422b4ed282SShri Abhyankar    Input Parameter:
13432b4ed282SShri Abhyankar .  snes - the SNES context
13442b4ed282SShri Abhyankar 
13452b4ed282SShri Abhyankar    Application Interface Routine: SNESDestroy()
13462b4ed282SShri Abhyankar  */
13472b4ed282SShri Abhyankar #undef __FUNCT__
13482b4ed282SShri Abhyankar #define __FUNCT__ "SNESDestroy_VI"
13492b4ed282SShri Abhyankar PetscErrorCode SNESDestroy_VI(SNES snes)
13502b4ed282SShri Abhyankar {
13512b4ed282SShri Abhyankar   SNES_VI        *vi = (SNES_VI*) snes->data;
13522b4ed282SShri Abhyankar   PetscErrorCode ierr;
13532b4ed282SShri Abhyankar 
13542b4ed282SShri Abhyankar   PetscFunctionBegin;
13552b4ed282SShri Abhyankar   if (snes->vec_sol_update) {
13562b4ed282SShri Abhyankar     ierr = VecDestroy(snes->vec_sol_update);CHKERRQ(ierr);
13572b4ed282SShri Abhyankar     snes->vec_sol_update = PETSC_NULL;
13582b4ed282SShri Abhyankar   }
13592b4ed282SShri Abhyankar   if (snes->nwork) {
13602b4ed282SShri Abhyankar     ierr = VecDestroyVecs(snes->work,snes->nwork);CHKERRQ(ierr);
13612b4ed282SShri Abhyankar     snes->nwork = 0;
13622b4ed282SShri Abhyankar     snes->work  = PETSC_NULL;
13632b4ed282SShri Abhyankar   }
13642b4ed282SShri Abhyankar 
13652b4ed282SShri Abhyankar   /* clear vectors */
1366ee657d29SShri Abhyankar   ierr = VecDestroy(vi->dpsi);CHKERRQ(ierr);
13672b4ed282SShri Abhyankar   ierr = VecDestroy(vi->phi); CHKERRQ(ierr);
13682b4ed282SShri Abhyankar   ierr = VecDestroy(vi->Da); CHKERRQ(ierr);
13692b4ed282SShri Abhyankar   ierr = VecDestroy(vi->Db); CHKERRQ(ierr);
13702b4ed282SShri Abhyankar   ierr = VecDestroy(vi->z); CHKERRQ(ierr);
13712b4ed282SShri Abhyankar   ierr = VecDestroy(vi->t); CHKERRQ(ierr);
13722b4ed282SShri Abhyankar   if (!vi->usersetxbounds) {
13732b4ed282SShri Abhyankar     ierr = VecDestroy(vi->xl); CHKERRQ(ierr);
13742b4ed282SShri Abhyankar     ierr = VecDestroy(vi->xu); CHKERRQ(ierr);
13752b4ed282SShri Abhyankar   }
1376c92abb8aSShri Abhyankar   if (vi->lsmonitor) {
1377c92abb8aSShri Abhyankar     ierr = PetscViewerASCIIMonitorDestroy(vi->lsmonitor);CHKERRQ(ierr);
13782b4ed282SShri Abhyankar   }
13792b4ed282SShri Abhyankar   ierr = PetscFree(snes->data);CHKERRQ(ierr);
13802b4ed282SShri Abhyankar 
13812b4ed282SShri Abhyankar   /* clear composed functions */
13822b4ed282SShri Abhyankar   ierr = PetscObjectComposeFunctionDynamic((PetscObject)snes,"SNESLineSearchSet_C","",PETSC_NULL);CHKERRQ(ierr);
1383c92abb8aSShri Abhyankar   ierr = PetscObjectComposeFunctionDynamic((PetscObject)snes,"SNESLineSearchSetMonitor_C","",PETSC_NULL);CHKERRQ(ierr);
13842b4ed282SShri Abhyankar   PetscFunctionReturn(0);
13852b4ed282SShri Abhyankar }
13862b4ed282SShri Abhyankar /* -------------------------------------------------------------------------- */
13872b4ed282SShri Abhyankar #undef __FUNCT__
13882b4ed282SShri Abhyankar #define __FUNCT__ "SNESLineSearchNo_VI"
13892b4ed282SShri Abhyankar 
13902b4ed282SShri Abhyankar /*
13912b4ed282SShri Abhyankar   This routine is a copy of SNESLineSearchNo routine in snes/impls/ls/ls.c
13922b4ed282SShri Abhyankar 
13932b4ed282SShri Abhyankar */
1394ace3abfcSBarry 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)
13952b4ed282SShri Abhyankar {
13962b4ed282SShri Abhyankar   PetscErrorCode ierr;
13972b4ed282SShri Abhyankar   SNES_VI        *vi = (SNES_VI*)snes->data;
1398ace3abfcSBarry Smith   PetscBool     changed_w = PETSC_FALSE,changed_y = PETSC_FALSE;
13992b4ed282SShri Abhyankar 
14002b4ed282SShri Abhyankar   PetscFunctionBegin;
14012b4ed282SShri Abhyankar   *flag = PETSC_TRUE;
14022b4ed282SShri Abhyankar   ierr = PetscLogEventBegin(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr);
14032b4ed282SShri Abhyankar   ierr = VecNorm(y,NORM_2,ynorm);CHKERRQ(ierr);         /* ynorm = || y || */
14042b4ed282SShri Abhyankar   ierr = VecWAXPY(w,-1.0,y,x);CHKERRQ(ierr);            /* w <- x - y   */
14052b4ed282SShri Abhyankar   if (vi->postcheckstep) {
14062b4ed282SShri Abhyankar    ierr = (*vi->postcheckstep)(snes,x,y,w,vi->postcheck,&changed_y,&changed_w);CHKERRQ(ierr);
14072b4ed282SShri Abhyankar   }
14082b4ed282SShri Abhyankar   if (changed_y) {
14092b4ed282SShri Abhyankar     ierr = VecWAXPY(w,-1.0,y,x);CHKERRQ(ierr);            /* w <- x - y   */
14102b4ed282SShri Abhyankar   }
14112b4ed282SShri Abhyankar   ierr = SNESComputeFunction(snes,w,g);CHKERRQ(ierr);
14122b4ed282SShri Abhyankar   if (!snes->domainerror) {
14132b4ed282SShri Abhyankar     ierr = VecNorm(g,NORM_2,gnorm);CHKERRQ(ierr);  /* gnorm = || g || */
14142b4ed282SShri Abhyankar     if PetscIsInfOrNanReal(*gnorm) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FP,"User provided compute function generated a Not-a-Number");
14152b4ed282SShri Abhyankar   }
1416c92abb8aSShri Abhyankar   if (vi->lsmonitor) {
1417c92abb8aSShri Abhyankar     ierr = PetscViewerASCIIMonitorPrintf(vi->lsmonitor,"    Line search: Using full step: fnorm %G gnorm %G\n",fnorm,*gnorm);CHKERRQ(ierr);
1418c92abb8aSShri Abhyankar   }
14192b4ed282SShri Abhyankar   ierr = PetscLogEventEnd(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr);
14202b4ed282SShri Abhyankar   PetscFunctionReturn(0);
14212b4ed282SShri Abhyankar }
14222b4ed282SShri Abhyankar 
14232b4ed282SShri Abhyankar /* -------------------------------------------------------------------------- */
14242b4ed282SShri Abhyankar #undef __FUNCT__
14252b4ed282SShri Abhyankar #define __FUNCT__ "SNESLineSearchNoNorms_VI"
14262b4ed282SShri Abhyankar 
14272b4ed282SShri Abhyankar /*
14282b4ed282SShri Abhyankar   This routine is a copy of SNESLineSearchNoNorms in snes/impls/ls/ls.c
14292b4ed282SShri Abhyankar */
1430ace3abfcSBarry 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)
14312b4ed282SShri Abhyankar {
14322b4ed282SShri Abhyankar   PetscErrorCode ierr;
14332b4ed282SShri Abhyankar   SNES_VI        *vi = (SNES_VI*)snes->data;
1434ace3abfcSBarry Smith   PetscBool     changed_w = PETSC_FALSE,changed_y = PETSC_FALSE;
14352b4ed282SShri Abhyankar 
14362b4ed282SShri Abhyankar   PetscFunctionBegin;
14372b4ed282SShri Abhyankar   *flag = PETSC_TRUE;
14382b4ed282SShri Abhyankar   ierr = PetscLogEventBegin(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr);
14392b4ed282SShri Abhyankar   ierr = VecWAXPY(w,-1.0,y,x);CHKERRQ(ierr);            /* w <- x - y      */
14402b4ed282SShri Abhyankar   if (vi->postcheckstep) {
14412b4ed282SShri Abhyankar    ierr = (*vi->postcheckstep)(snes,x,y,w,vi->postcheck,&changed_y,&changed_w);CHKERRQ(ierr);
14422b4ed282SShri Abhyankar   }
14432b4ed282SShri Abhyankar   if (changed_y) {
14442b4ed282SShri Abhyankar     ierr = VecWAXPY(w,-1.0,y,x);CHKERRQ(ierr);            /* w <- x - y   */
14452b4ed282SShri Abhyankar   }
14462b4ed282SShri Abhyankar 
14472b4ed282SShri Abhyankar   /* don't evaluate function the last time through */
14482b4ed282SShri Abhyankar   if (snes->iter < snes->max_its-1) {
14492b4ed282SShri Abhyankar     ierr = SNESComputeFunction(snes,w,g);CHKERRQ(ierr);
14502b4ed282SShri Abhyankar   }
14512b4ed282SShri Abhyankar   ierr = PetscLogEventEnd(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr);
14522b4ed282SShri Abhyankar   PetscFunctionReturn(0);
14532b4ed282SShri Abhyankar }
14542b4ed282SShri Abhyankar /* -------------------------------------------------------------------------- */
14552b4ed282SShri Abhyankar #undef __FUNCT__
14562b4ed282SShri Abhyankar #define __FUNCT__ "SNESLineSearchCubic_VI"
14572b4ed282SShri Abhyankar /*
14582b4ed282SShri Abhyankar   This routine is a copy of SNESLineSearchCubic in snes/impls/ls/ls.c
14592b4ed282SShri Abhyankar */
1460ace3abfcSBarry 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)
14612b4ed282SShri Abhyankar {
14622b4ed282SShri Abhyankar   /*
14632b4ed282SShri Abhyankar      Note that for line search purposes we work with with the related
14642b4ed282SShri Abhyankar      minimization problem:
14652b4ed282SShri Abhyankar         min  z(x):  R^n -> R,
14662b4ed282SShri Abhyankar      where z(x) = .5 * fnorm*fnorm, and fnorm = || f ||_2.
14672b4ed282SShri Abhyankar      This function z(x) is same as the merit function for the complementarity problem.
14682b4ed282SShri Abhyankar    */
14692b4ed282SShri Abhyankar 
14702b4ed282SShri Abhyankar   PetscReal      initslope,lambdaprev,gnormprev,a,b,d,t1,t2,rellength;
14712b4ed282SShri Abhyankar   PetscReal      minlambda,lambda,lambdatemp;
14722b4ed282SShri Abhyankar #if defined(PETSC_USE_COMPLEX)
14732b4ed282SShri Abhyankar   PetscScalar    cinitslope;
14742b4ed282SShri Abhyankar #endif
14752b4ed282SShri Abhyankar   PetscErrorCode ierr;
14762b4ed282SShri Abhyankar   PetscInt       count;
14772b4ed282SShri Abhyankar   SNES_VI      *vi = (SNES_VI*)snes->data;
1478ace3abfcSBarry Smith   PetscBool     changed_w = PETSC_FALSE,changed_y = PETSC_FALSE;
14792b4ed282SShri Abhyankar   MPI_Comm       comm;
14802b4ed282SShri Abhyankar 
14812b4ed282SShri Abhyankar   PetscFunctionBegin;
14822b4ed282SShri Abhyankar   ierr = PetscObjectGetComm((PetscObject)snes,&comm);CHKERRQ(ierr);
14832b4ed282SShri Abhyankar   ierr = PetscLogEventBegin(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr);
14842b4ed282SShri Abhyankar   *flag   = PETSC_TRUE;
14852b4ed282SShri Abhyankar 
14862b4ed282SShri Abhyankar   ierr = VecNorm(y,NORM_2,ynorm);CHKERRQ(ierr);
14872b4ed282SShri Abhyankar   if (*ynorm == 0.0) {
1488c92abb8aSShri Abhyankar     if (vi->lsmonitor) {
1489c92abb8aSShri Abhyankar       ierr = PetscViewerASCIIMonitorPrintf(vi->lsmonitor,"    Line search: Initial direction and size is 0\n");CHKERRQ(ierr);
14902b4ed282SShri Abhyankar     }
14912b4ed282SShri Abhyankar     *gnorm = fnorm;
14922b4ed282SShri Abhyankar     ierr   = VecCopy(x,w);CHKERRQ(ierr);
14932b4ed282SShri Abhyankar     ierr   = VecCopy(f,g);CHKERRQ(ierr);
14942b4ed282SShri Abhyankar     *flag  = PETSC_FALSE;
14952b4ed282SShri Abhyankar     goto theend1;
14962b4ed282SShri Abhyankar   }
14972b4ed282SShri Abhyankar   if (*ynorm > vi->maxstep) {	/* Step too big, so scale back */
1498c92abb8aSShri Abhyankar     if (vi->lsmonitor) {
1499c92abb8aSShri Abhyankar       ierr = PetscViewerASCIIMonitorPrintf(vi->lsmonitor,"    Line search: Scaling step by %G old ynorm %G\n",vi->maxstep/(*ynorm),*ynorm);CHKERRQ(ierr);
15002b4ed282SShri Abhyankar     }
15012b4ed282SShri Abhyankar     ierr = VecScale(y,vi->maxstep/(*ynorm));CHKERRQ(ierr);
15022b4ed282SShri Abhyankar     *ynorm = vi->maxstep;
15032b4ed282SShri Abhyankar   }
15042b4ed282SShri Abhyankar   ierr      = VecMaxPointwiseDivide(y,x,&rellength);CHKERRQ(ierr);
15052b4ed282SShri Abhyankar   minlambda = vi->minlambda/rellength;
15062b4ed282SShri Abhyankar #if defined(PETSC_USE_COMPLEX)
150789d9e806SShri Abhyankar   ierr = VecDot(vi->dpsi,y,&cinitslope);CHKERRQ(ierr);
15082b4ed282SShri Abhyankar   initslope = PetscRealPart(cinitslope);
15092b4ed282SShri Abhyankar #else
151089d9e806SShri Abhyankar   ierr = VecDot(vi->dpsi,y,&initslope);CHKERRQ(ierr);
15112b4ed282SShri Abhyankar #endif
15122b4ed282SShri Abhyankar   if (initslope > 0.0)  initslope = -initslope;
15132b4ed282SShri Abhyankar   if (initslope == 0.0) initslope = -1.0;
15142b4ed282SShri Abhyankar 
15152b4ed282SShri Abhyankar   ierr = VecWAXPY(w,-1.0,y,x);CHKERRQ(ierr);
15162b4ed282SShri Abhyankar   if (snes->nfuncs >= snes->max_funcs) {
15172b4ed282SShri Abhyankar     ierr  = PetscInfo(snes,"Exceeded maximum function evaluations, while checking full step length!\n");CHKERRQ(ierr);
15182b4ed282SShri Abhyankar     *flag = PETSC_FALSE;
15192b4ed282SShri Abhyankar     snes->reason = SNES_DIVERGED_FUNCTION_COUNT;
15202b4ed282SShri Abhyankar     goto theend1;
15212b4ed282SShri Abhyankar   }
15222b4ed282SShri Abhyankar   ierr = SNESComputeFunction(snes,w,g);CHKERRQ(ierr);
15232b4ed282SShri Abhyankar   if (snes->domainerror) {
15242b4ed282SShri Abhyankar     ierr = PetscLogEventEnd(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr);
15252b4ed282SShri Abhyankar     PetscFunctionReturn(0);
15262b4ed282SShri Abhyankar   }
15272b4ed282SShri Abhyankar   ierr = VecNorm(g,NORM_2,gnorm);CHKERRQ(ierr);
15282b4ed282SShri Abhyankar   if PetscIsInfOrNanReal(*gnorm) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FP,"User provided compute function generated a Not-a-Number");
15292b4ed282SShri Abhyankar   ierr = PetscInfo2(snes,"Initial fnorm %G gnorm %G\n",fnorm,*gnorm);CHKERRQ(ierr);
15302b4ed282SShri Abhyankar   if (.5*(*gnorm)*(*gnorm) <= .5*fnorm*fnorm + vi->alpha*initslope) { /* Sufficient reduction */
1531c92abb8aSShri Abhyankar     if (vi->lsmonitor) {
1532c92abb8aSShri Abhyankar       ierr = PetscViewerASCIIMonitorPrintf(vi->lsmonitor,"    Line search: Using full step: fnorm %G gnorm %G\n",fnorm,*gnorm);CHKERRQ(ierr);
15332b4ed282SShri Abhyankar     }
15342b4ed282SShri Abhyankar     goto theend1;
15352b4ed282SShri Abhyankar   }
15362b4ed282SShri Abhyankar 
15372b4ed282SShri Abhyankar   /* Fit points with quadratic */
15382b4ed282SShri Abhyankar   lambda     = 1.0;
15392b4ed282SShri Abhyankar   lambdatemp = -initslope/((*gnorm)*(*gnorm) - fnorm*fnorm - 2.0*initslope);
15402b4ed282SShri Abhyankar   lambdaprev = lambda;
15412b4ed282SShri Abhyankar   gnormprev  = *gnorm;
15422b4ed282SShri Abhyankar   if (lambdatemp > .5*lambda)  lambdatemp = .5*lambda;
15432b4ed282SShri Abhyankar   if (lambdatemp <= .1*lambda) lambda = .1*lambda;
15442b4ed282SShri Abhyankar   else                         lambda = lambdatemp;
15452b4ed282SShri Abhyankar 
15462b4ed282SShri Abhyankar   ierr  = VecWAXPY(w,-lambda,y,x);CHKERRQ(ierr);
15472b4ed282SShri Abhyankar   if (snes->nfuncs >= snes->max_funcs) {
15482b4ed282SShri Abhyankar     ierr  = PetscInfo1(snes,"Exceeded maximum function evaluations, while attempting quadratic backtracking! %D \n",snes->nfuncs);CHKERRQ(ierr);
15492b4ed282SShri Abhyankar     *flag = PETSC_FALSE;
15502b4ed282SShri Abhyankar     snes->reason = SNES_DIVERGED_FUNCTION_COUNT;
15512b4ed282SShri Abhyankar     goto theend1;
15522b4ed282SShri Abhyankar   }
15532b4ed282SShri Abhyankar   ierr = SNESComputeFunction(snes,w,g);CHKERRQ(ierr);
15542b4ed282SShri Abhyankar   if (snes->domainerror) {
15552b4ed282SShri Abhyankar     ierr = PetscLogEventEnd(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr);
15562b4ed282SShri Abhyankar     PetscFunctionReturn(0);
15572b4ed282SShri Abhyankar   }
15582b4ed282SShri Abhyankar   ierr = VecNorm(g,NORM_2,gnorm);CHKERRQ(ierr);
15592b4ed282SShri Abhyankar   if PetscIsInfOrNanReal(*gnorm) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FP,"User provided compute function generated a Not-a-Number");
1560c92abb8aSShri Abhyankar   if (vi->lsmonitor) {
1561c92abb8aSShri Abhyankar     ierr = PetscViewerASCIIMonitorPrintf(vi->lsmonitor,"    Line search: gnorm after quadratic fit %G\n",*gnorm);CHKERRQ(ierr);
15622b4ed282SShri Abhyankar   }
15632b4ed282SShri Abhyankar   if (.5*(*gnorm)*(*gnorm) < .5*fnorm*fnorm + lambda*vi->alpha*initslope) { /* sufficient reduction */
1564c92abb8aSShri Abhyankar     if (vi->lsmonitor) {
1565c92abb8aSShri Abhyankar       ierr = PetscViewerASCIIMonitorPrintf(vi->lsmonitor,"    Line search: Quadratically determined step, lambda=%18.16e\n",lambda);CHKERRQ(ierr);
15662b4ed282SShri Abhyankar     }
15672b4ed282SShri Abhyankar     goto theend1;
15682b4ed282SShri Abhyankar   }
15692b4ed282SShri Abhyankar 
15702b4ed282SShri Abhyankar   /* Fit points with cubic */
15712b4ed282SShri Abhyankar   count = 1;
15722b4ed282SShri Abhyankar   while (PETSC_TRUE) {
15732b4ed282SShri Abhyankar     if (lambda <= minlambda) {
1574c92abb8aSShri Abhyankar       if (vi->lsmonitor) {
1575c92abb8aSShri Abhyankar 	ierr = PetscViewerASCIIMonitorPrintf(vi->lsmonitor,"    Line search: unable to find good step length! After %D tries \n",count);CHKERRQ(ierr);
1576c92abb8aSShri 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);
15772b4ed282SShri Abhyankar       }
15782b4ed282SShri Abhyankar       *flag = PETSC_FALSE;
15792b4ed282SShri Abhyankar       break;
15802b4ed282SShri Abhyankar     }
15812b4ed282SShri Abhyankar     t1 = .5*((*gnorm)*(*gnorm) - fnorm*fnorm) - lambda*initslope;
15822b4ed282SShri Abhyankar     t2 = .5*(gnormprev*gnormprev  - fnorm*fnorm) - lambdaprev*initslope;
15832b4ed282SShri Abhyankar     a  = (t1/(lambda*lambda) - t2/(lambdaprev*lambdaprev))/(lambda-lambdaprev);
15842b4ed282SShri Abhyankar     b  = (-lambdaprev*t1/(lambda*lambda) + lambda*t2/(lambdaprev*lambdaprev))/(lambda-lambdaprev);
15852b4ed282SShri Abhyankar     d  = b*b - 3*a*initslope;
15862b4ed282SShri Abhyankar     if (d < 0.0) d = 0.0;
15872b4ed282SShri Abhyankar     if (a == 0.0) {
15882b4ed282SShri Abhyankar       lambdatemp = -initslope/(2.0*b);
15892b4ed282SShri Abhyankar     } else {
15902b4ed282SShri Abhyankar       lambdatemp = (-b + sqrt(d))/(3.0*a);
15912b4ed282SShri Abhyankar     }
15922b4ed282SShri Abhyankar     lambdaprev = lambda;
15932b4ed282SShri Abhyankar     gnormprev  = *gnorm;
15942b4ed282SShri Abhyankar     if (lambdatemp > .5*lambda)  lambdatemp = .5*lambda;
15952b4ed282SShri Abhyankar     if (lambdatemp <= .1*lambda) lambda     = .1*lambda;
15962b4ed282SShri Abhyankar     else                         lambda     = lambdatemp;
15972b4ed282SShri Abhyankar     ierr  = VecWAXPY(w,-lambda,y,x);CHKERRQ(ierr);
15982b4ed282SShri Abhyankar     if (snes->nfuncs >= snes->max_funcs) {
15992b4ed282SShri Abhyankar       ierr = PetscInfo1(snes,"Exceeded maximum function evaluations, while looking for good step length! %D \n",count);CHKERRQ(ierr);
16002b4ed282SShri 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);
16012b4ed282SShri Abhyankar       *flag = PETSC_FALSE;
16022b4ed282SShri Abhyankar       snes->reason = SNES_DIVERGED_FUNCTION_COUNT;
16032b4ed282SShri Abhyankar       break;
16042b4ed282SShri Abhyankar     }
16052b4ed282SShri Abhyankar     ierr = SNESComputeFunction(snes,w,g);CHKERRQ(ierr);
16062b4ed282SShri Abhyankar     if (snes->domainerror) {
16072b4ed282SShri Abhyankar       ierr = PetscLogEventEnd(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr);
16082b4ed282SShri Abhyankar       PetscFunctionReturn(0);
16092b4ed282SShri Abhyankar     }
16102b4ed282SShri Abhyankar     ierr = VecNorm(g,NORM_2,gnorm);CHKERRQ(ierr);
16112b4ed282SShri Abhyankar     if PetscIsInfOrNanReal(*gnorm) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FP,"User provided compute function generated a Not-a-Number");
16122b4ed282SShri Abhyankar     if (.5*(*gnorm)*(*gnorm) < .5*fnorm*fnorm + lambda*vi->alpha*initslope) { /* is reduction enough? */
1613c92abb8aSShri Abhyankar       if (vi->lsmonitor) {
16142b4ed282SShri Abhyankar 	ierr = PetscPrintf(comm,"    Line search: Cubically determined step, current gnorm %G lambda=%18.16e\n",*gnorm,lambda);CHKERRQ(ierr);
16152b4ed282SShri Abhyankar       }
16162b4ed282SShri Abhyankar       break;
16172b4ed282SShri Abhyankar     } else {
1618c92abb8aSShri Abhyankar       if (vi->lsmonitor) {
16192b4ed282SShri Abhyankar         ierr = PetscPrintf(comm,"    Line search: Cubic step no good, shrinking lambda, current gnorm %G lambda=%18.16e\n",*gnorm,lambda);CHKERRQ(ierr);
16202b4ed282SShri Abhyankar       }
16212b4ed282SShri Abhyankar     }
16222b4ed282SShri Abhyankar     count++;
16232b4ed282SShri Abhyankar   }
16242b4ed282SShri Abhyankar   theend1:
16252b4ed282SShri Abhyankar   /* Optional user-defined check for line search step validity */
16262b4ed282SShri Abhyankar   if (vi->postcheckstep && *flag) {
16272b4ed282SShri Abhyankar     ierr = (*vi->postcheckstep)(snes,x,y,w,vi->postcheck,&changed_y,&changed_w);CHKERRQ(ierr);
16282b4ed282SShri Abhyankar     if (changed_y) {
16292b4ed282SShri Abhyankar       ierr = VecWAXPY(w,-1.0,y,x);CHKERRQ(ierr);
16302b4ed282SShri Abhyankar     }
16312b4ed282SShri Abhyankar     if (changed_y || changed_w) { /* recompute the function if the step has changed */
16322b4ed282SShri Abhyankar       ierr = SNESComputeFunction(snes,w,g);CHKERRQ(ierr);
16332b4ed282SShri Abhyankar       if (snes->domainerror) {
16342b4ed282SShri Abhyankar         ierr = PetscLogEventEnd(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr);
16352b4ed282SShri Abhyankar         PetscFunctionReturn(0);
16362b4ed282SShri Abhyankar       }
16372b4ed282SShri Abhyankar       ierr = VecNormBegin(g,NORM_2,gnorm);CHKERRQ(ierr);
16382b4ed282SShri Abhyankar       if PetscIsInfOrNanReal(*gnorm) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FP,"User provided compute function generated a Not-a-Number");
16392b4ed282SShri Abhyankar       ierr = VecNormBegin(y,NORM_2,ynorm);CHKERRQ(ierr);
16402b4ed282SShri Abhyankar       ierr = VecNormEnd(g,NORM_2,gnorm);CHKERRQ(ierr);
16412b4ed282SShri Abhyankar       ierr = VecNormEnd(y,NORM_2,ynorm);CHKERRQ(ierr);
16422b4ed282SShri Abhyankar     }
16432b4ed282SShri Abhyankar   }
16442b4ed282SShri Abhyankar   ierr = PetscLogEventEnd(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr);
16452b4ed282SShri Abhyankar   PetscFunctionReturn(0);
16462b4ed282SShri Abhyankar }
16472b4ed282SShri Abhyankar /* -------------------------------------------------------------------------- */
16482b4ed282SShri Abhyankar #undef __FUNCT__
16492b4ed282SShri Abhyankar #define __FUNCT__ "SNESLineSearchQuadratic_VI"
16502b4ed282SShri Abhyankar /*
16512b4ed282SShri Abhyankar   This routine is a copy of SNESLineSearchQuadratic in snes/impls/ls/ls.c
16522b4ed282SShri Abhyankar */
1653ace3abfcSBarry 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)
16542b4ed282SShri Abhyankar {
16552b4ed282SShri Abhyankar   /*
16562b4ed282SShri Abhyankar      Note that for line search purposes we work with with the related
16572b4ed282SShri Abhyankar      minimization problem:
16582b4ed282SShri Abhyankar         min  z(x):  R^n -> R,
16592b4ed282SShri Abhyankar      where z(x) = .5 * fnorm*fnorm,and fnorm = || f ||_2.
16602b4ed282SShri Abhyankar      z(x) is the same as the merit function for the complementarity problem
16612b4ed282SShri Abhyankar    */
16622b4ed282SShri Abhyankar   PetscReal      initslope,minlambda,lambda,lambdatemp,rellength;
16632b4ed282SShri Abhyankar #if defined(PETSC_USE_COMPLEX)
16642b4ed282SShri Abhyankar   PetscScalar    cinitslope;
16652b4ed282SShri Abhyankar #endif
16662b4ed282SShri Abhyankar   PetscErrorCode ierr;
16672b4ed282SShri Abhyankar   PetscInt       count;
16682b4ed282SShri Abhyankar   SNES_VI        *vi = (SNES_VI*)snes->data;
1669ace3abfcSBarry Smith   PetscBool     changed_w = PETSC_FALSE,changed_y = PETSC_FALSE;
16702b4ed282SShri Abhyankar 
16712b4ed282SShri Abhyankar   PetscFunctionBegin;
16722b4ed282SShri Abhyankar   ierr    = PetscLogEventBegin(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr);
16732b4ed282SShri Abhyankar   *flag   = PETSC_TRUE;
16742b4ed282SShri Abhyankar 
16752b4ed282SShri Abhyankar   ierr = VecNorm(y,NORM_2,ynorm);CHKERRQ(ierr);
16762b4ed282SShri Abhyankar   if (*ynorm == 0.0) {
1677c92abb8aSShri Abhyankar     if (vi->lsmonitor) {
1678c92abb8aSShri Abhyankar       ierr = PetscViewerASCIIMonitorPrintf(vi->lsmonitor,"Line search: Direction and size is 0\n");CHKERRQ(ierr);
16792b4ed282SShri Abhyankar     }
16802b4ed282SShri Abhyankar     *gnorm = fnorm;
16812b4ed282SShri Abhyankar     ierr   = VecCopy(x,w);CHKERRQ(ierr);
16822b4ed282SShri Abhyankar     ierr   = VecCopy(f,g);CHKERRQ(ierr);
16832b4ed282SShri Abhyankar     *flag  = PETSC_FALSE;
16842b4ed282SShri Abhyankar     goto theend2;
16852b4ed282SShri Abhyankar   }
16862b4ed282SShri Abhyankar   if (*ynorm > vi->maxstep) {	/* Step too big, so scale back */
16872b4ed282SShri Abhyankar     ierr   = VecScale(y,vi->maxstep/(*ynorm));CHKERRQ(ierr);
16882b4ed282SShri Abhyankar     *ynorm = vi->maxstep;
16892b4ed282SShri Abhyankar   }
16902b4ed282SShri Abhyankar   ierr      = VecMaxPointwiseDivide(y,x,&rellength);CHKERRQ(ierr);
16912b4ed282SShri Abhyankar   minlambda = vi->minlambda/rellength;
16922b4ed282SShri Abhyankar #if defined(PETSC_USE_COMPLEX)
169389d9e806SShri Abhyankar   ierr      = VecDot(vi->dpsi,y,&cinitslope);CHKERRQ(ierr);
16942b4ed282SShri Abhyankar   initslope = PetscRealPart(cinitslope);
16952b4ed282SShri Abhyankar #else
169689d9e806SShri Abhyankar   ierr = VecDot(vi->dpsi,y,&initslope);CHKERRQ(ierr);
16972b4ed282SShri Abhyankar #endif
16982b4ed282SShri Abhyankar   if (initslope > 0.0)  initslope = -initslope;
16992b4ed282SShri Abhyankar   if (initslope == 0.0) initslope = -1.0;
17002b4ed282SShri Abhyankar   ierr = PetscInfo1(snes,"Initslope %G \n",initslope);CHKERRQ(ierr);
17012b4ed282SShri Abhyankar 
17022b4ed282SShri Abhyankar   ierr = VecWAXPY(w,-1.0,y,x);CHKERRQ(ierr);
17032b4ed282SShri Abhyankar   if (snes->nfuncs >= snes->max_funcs) {
17042b4ed282SShri Abhyankar     ierr  = PetscInfo(snes,"Exceeded maximum function evaluations, while checking full step length!\n");CHKERRQ(ierr);
17052b4ed282SShri Abhyankar     *flag = PETSC_FALSE;
17062b4ed282SShri Abhyankar     snes->reason = SNES_DIVERGED_FUNCTION_COUNT;
17072b4ed282SShri Abhyankar     goto theend2;
17082b4ed282SShri Abhyankar   }
17092b4ed282SShri Abhyankar   ierr = SNESComputeFunction(snes,w,g);CHKERRQ(ierr);
17102b4ed282SShri Abhyankar   if (snes->domainerror) {
17112b4ed282SShri Abhyankar     ierr = PetscLogEventEnd(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr);
17122b4ed282SShri Abhyankar     PetscFunctionReturn(0);
17132b4ed282SShri Abhyankar   }
17142b4ed282SShri Abhyankar   ierr = VecNorm(g,NORM_2,gnorm);CHKERRQ(ierr);
17152b4ed282SShri Abhyankar   if PetscIsInfOrNanReal(*gnorm) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FP,"User provided compute function generated a Not-a-Number");
17162b4ed282SShri Abhyankar   if (.5*(*gnorm)*(*gnorm) <= .5*fnorm*fnorm + vi->alpha*initslope) { /* Sufficient reduction */
1717c92abb8aSShri Abhyankar     if (vi->lsmonitor) {
1718c92abb8aSShri Abhyankar       ierr = PetscViewerASCIIMonitorPrintf(vi->lsmonitor,"    Line search: Using full step: fnorm %G gnorm %G\n",fnorm,*gnorm);CHKERRQ(ierr);
17192b4ed282SShri Abhyankar     }
17202b4ed282SShri Abhyankar     goto theend2;
17212b4ed282SShri Abhyankar   }
17222b4ed282SShri Abhyankar 
17232b4ed282SShri Abhyankar   /* Fit points with quadratic */
17242b4ed282SShri Abhyankar   lambda = 1.0;
17252b4ed282SShri Abhyankar   count = 1;
17262b4ed282SShri Abhyankar   while (PETSC_TRUE) {
17272b4ed282SShri Abhyankar     if (lambda <= minlambda) { /* bad luck; use full step */
1728c92abb8aSShri Abhyankar       if (vi->lsmonitor) {
1729c92abb8aSShri Abhyankar         ierr = PetscViewerASCIIMonitorPrintf(vi->lsmonitor,"Line search: Unable to find good step length! %D \n",count);CHKERRQ(ierr);
1730c92abb8aSShri 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);
17312b4ed282SShri Abhyankar       }
17322b4ed282SShri Abhyankar       ierr = VecCopy(x,w);CHKERRQ(ierr);
17332b4ed282SShri Abhyankar       *flag = PETSC_FALSE;
17342b4ed282SShri Abhyankar       break;
17352b4ed282SShri Abhyankar     }
17362b4ed282SShri Abhyankar     lambdatemp = -initslope/((*gnorm)*(*gnorm) - fnorm*fnorm - 2.0*initslope);
17372b4ed282SShri Abhyankar     if (lambdatemp > .5*lambda)  lambdatemp = .5*lambda;
17382b4ed282SShri Abhyankar     if (lambdatemp <= .1*lambda) lambda     = .1*lambda;
17392b4ed282SShri Abhyankar     else                         lambda     = lambdatemp;
17402b4ed282SShri Abhyankar 
17412b4ed282SShri Abhyankar     ierr = VecWAXPY(w,-lambda,y,x);CHKERRQ(ierr);
17422b4ed282SShri Abhyankar     if (snes->nfuncs >= snes->max_funcs) {
17432b4ed282SShri Abhyankar       ierr  = PetscInfo1(snes,"Exceeded maximum function evaluations, while looking for good step length! %D \n",count);CHKERRQ(ierr);
17442b4ed282SShri 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);
17452b4ed282SShri Abhyankar       *flag = PETSC_FALSE;
17462b4ed282SShri Abhyankar       snes->reason = SNES_DIVERGED_FUNCTION_COUNT;
17472b4ed282SShri Abhyankar       break;
17482b4ed282SShri Abhyankar     }
17492b4ed282SShri Abhyankar     ierr = SNESComputeFunction(snes,w,g);CHKERRQ(ierr);
17502b4ed282SShri Abhyankar     if (snes->domainerror) {
17512b4ed282SShri Abhyankar       ierr = PetscLogEventEnd(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr);
17522b4ed282SShri Abhyankar       PetscFunctionReturn(0);
17532b4ed282SShri Abhyankar     }
17542b4ed282SShri Abhyankar     ierr = VecNorm(g,NORM_2,gnorm);CHKERRQ(ierr);
17552b4ed282SShri Abhyankar     if PetscIsInfOrNanReal(*gnorm) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FP,"User provided compute function generated a Not-a-Number");
17562b4ed282SShri Abhyankar     if (.5*(*gnorm)*(*gnorm) < .5*fnorm*fnorm + lambda*vi->alpha*initslope) { /* sufficient reduction */
1757c92abb8aSShri Abhyankar       if (vi->lsmonitor) {
1758c92abb8aSShri Abhyankar         ierr = PetscViewerASCIIMonitorPrintf(vi->lsmonitor,"    Line Search: Quadratically determined step, lambda=%G\n",lambda);CHKERRQ(ierr);
17592b4ed282SShri Abhyankar       }
17602b4ed282SShri Abhyankar       break;
17612b4ed282SShri Abhyankar     }
17622b4ed282SShri Abhyankar     count++;
17632b4ed282SShri Abhyankar   }
17642b4ed282SShri Abhyankar   theend2:
17652b4ed282SShri Abhyankar   /* Optional user-defined check for line search step validity */
17662b4ed282SShri Abhyankar   if (vi->postcheckstep) {
17672b4ed282SShri Abhyankar     ierr = (*vi->postcheckstep)(snes,x,y,w,vi->postcheck,&changed_y,&changed_w);CHKERRQ(ierr);
17682b4ed282SShri Abhyankar     if (changed_y) {
17692b4ed282SShri Abhyankar       ierr = VecWAXPY(w,-1.0,y,x);CHKERRQ(ierr);
17702b4ed282SShri Abhyankar     }
17712b4ed282SShri Abhyankar     if (changed_y || changed_w) { /* recompute the function if the step has changed */
17722b4ed282SShri Abhyankar       ierr = SNESComputeFunction(snes,w,g);
17732b4ed282SShri Abhyankar       if (snes->domainerror) {
17742b4ed282SShri Abhyankar         ierr = PetscLogEventEnd(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr);
17752b4ed282SShri Abhyankar         PetscFunctionReturn(0);
17762b4ed282SShri Abhyankar       }
17772b4ed282SShri Abhyankar       ierr = VecNormBegin(g,NORM_2,gnorm);CHKERRQ(ierr);
17782b4ed282SShri Abhyankar       ierr = VecNormBegin(y,NORM_2,ynorm);CHKERRQ(ierr);
17792b4ed282SShri Abhyankar       ierr = VecNormEnd(g,NORM_2,gnorm);CHKERRQ(ierr);
17802b4ed282SShri Abhyankar       ierr = VecNormEnd(y,NORM_2,ynorm);CHKERRQ(ierr);
17812b4ed282SShri Abhyankar       if PetscIsInfOrNanReal(*gnorm) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FP,"User provided compute function generated a Not-a-Number");
17822b4ed282SShri Abhyankar     }
17832b4ed282SShri Abhyankar   }
17842b4ed282SShri Abhyankar   ierr = PetscLogEventEnd(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr);
17852b4ed282SShri Abhyankar   PetscFunctionReturn(0);
17862b4ed282SShri Abhyankar }
17872b4ed282SShri Abhyankar 
1788ace3abfcSBarry 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*/
17892b4ed282SShri Abhyankar /* -------------------------------------------------------------------------- */
17902b4ed282SShri Abhyankar EXTERN_C_BEGIN
17912b4ed282SShri Abhyankar #undef __FUNCT__
17922b4ed282SShri Abhyankar #define __FUNCT__ "SNESLineSearchSet_VI"
17932b4ed282SShri Abhyankar PetscErrorCode PETSCSNES_DLLEXPORT SNESLineSearchSet_VI(SNES snes,FCN2 func,void *lsctx)
17942b4ed282SShri Abhyankar {
17952b4ed282SShri Abhyankar   PetscFunctionBegin;
17962b4ed282SShri Abhyankar   ((SNES_VI *)(snes->data))->LineSearch = func;
17972b4ed282SShri Abhyankar   ((SNES_VI *)(snes->data))->lsP        = lsctx;
17982b4ed282SShri Abhyankar   PetscFunctionReturn(0);
17992b4ed282SShri Abhyankar }
18002b4ed282SShri Abhyankar EXTERN_C_END
18012b4ed282SShri Abhyankar 
18022b4ed282SShri Abhyankar /* -------------------------------------------------------------------------- */
18032b4ed282SShri Abhyankar EXTERN_C_BEGIN
18042b4ed282SShri Abhyankar #undef __FUNCT__
18052b4ed282SShri Abhyankar #define __FUNCT__ "SNESLineSearchSetMonitor_VI"
1806ace3abfcSBarry Smith PetscErrorCode PETSCSNES_DLLEXPORT SNESLineSearchSetMonitor_VI(SNES snes,PetscBool flg)
18072b4ed282SShri Abhyankar {
18082b4ed282SShri Abhyankar   SNES_VI        *vi = (SNES_VI*)snes->data;
18092b4ed282SShri Abhyankar   PetscErrorCode ierr;
18102b4ed282SShri Abhyankar 
18112b4ed282SShri Abhyankar   PetscFunctionBegin;
1812c92abb8aSShri Abhyankar   if (flg && !vi->lsmonitor) {
1813c92abb8aSShri Abhyankar     ierr = PetscViewerASCIIMonitorCreate(((PetscObject)snes)->comm,"stdout",((PetscObject)snes)->tablevel,&vi->lsmonitor);CHKERRQ(ierr);
1814c92abb8aSShri Abhyankar   } else if (!flg && vi->lsmonitor) {
1815c92abb8aSShri Abhyankar     ierr = PetscViewerASCIIMonitorDestroy(vi->lsmonitor);CHKERRQ(ierr);
18162b4ed282SShri Abhyankar   }
18172b4ed282SShri Abhyankar   PetscFunctionReturn(0);
18182b4ed282SShri Abhyankar }
18192b4ed282SShri Abhyankar EXTERN_C_END
18202b4ed282SShri Abhyankar 
18212b4ed282SShri Abhyankar /*
18222b4ed282SShri Abhyankar    SNESView_VI - Prints info from the SNESVI data structure.
18232b4ed282SShri Abhyankar 
18242b4ed282SShri Abhyankar    Input Parameters:
18252b4ed282SShri Abhyankar .  SNES - the SNES context
18262b4ed282SShri Abhyankar .  viewer - visualization context
18272b4ed282SShri Abhyankar 
18282b4ed282SShri Abhyankar    Application Interface Routine: SNESView()
18292b4ed282SShri Abhyankar */
18302b4ed282SShri Abhyankar #undef __FUNCT__
18312b4ed282SShri Abhyankar #define __FUNCT__ "SNESView_VI"
18322b4ed282SShri Abhyankar static PetscErrorCode SNESView_VI(SNES snes,PetscViewer viewer)
18332b4ed282SShri Abhyankar {
18342b4ed282SShri Abhyankar   SNES_VI        *vi = (SNES_VI *)snes->data;
183578c4b9d3SShri Abhyankar   const char     *cstr,*tstr;
18362b4ed282SShri Abhyankar   PetscErrorCode ierr;
1837ace3abfcSBarry Smith   PetscBool     iascii;
18382b4ed282SShri Abhyankar 
18392b4ed282SShri Abhyankar   PetscFunctionBegin;
18402b4ed282SShri Abhyankar   ierr = PetscTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
18412b4ed282SShri Abhyankar   if (iascii) {
18422b4ed282SShri Abhyankar     if (vi->LineSearch == SNESLineSearchNo_VI)             cstr = "SNESLineSearchNo";
18432b4ed282SShri Abhyankar     else if (vi->LineSearch == SNESLineSearchQuadratic_VI) cstr = "SNESLineSearchQuadratic";
18442b4ed282SShri Abhyankar     else if (vi->LineSearch == SNESLineSearchCubic_VI)     cstr = "SNESLineSearchCubic";
18452b4ed282SShri Abhyankar     else                                                cstr = "unknown";
184678c4b9d3SShri Abhyankar     if (snes->ops->solve == SNESSolveVI_SS)      tstr = "Semismooth";
184778c4b9d3SShri Abhyankar     else if (snes->ops->solve == SNESSolveVI_AS)  tstr = "Active Set";
18480a7c7af0SShri Abhyankar     else if (snes->ops->solve == SNESSolveVI_RS) tstr = "Reduced Space";
184978c4b9d3SShri Abhyankar     else                                         tstr = "unknown";
185078c4b9d3SShri Abhyankar     ierr = PetscViewerASCIIPrintf(viewer,"  VI algorithm: %s\n",tstr);CHKERRQ(ierr);
18512b4ed282SShri Abhyankar     ierr = PetscViewerASCIIPrintf(viewer,"  line search variant: %s\n",cstr);CHKERRQ(ierr);
18522b4ed282SShri Abhyankar     ierr = PetscViewerASCIIPrintf(viewer,"  alpha=%G, maxstep=%G, minlambda=%G\n",vi->alpha,vi->maxstep,vi->minlambda);CHKERRQ(ierr);
18532b4ed282SShri Abhyankar   } else {
18542b4ed282SShri Abhyankar     SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Viewer type %s not supported for SNES EQ VI",((PetscObject)viewer)->type_name);
18552b4ed282SShri Abhyankar   }
18562b4ed282SShri Abhyankar   PetscFunctionReturn(0);
18572b4ed282SShri Abhyankar }
18582b4ed282SShri Abhyankar 
18592b4ed282SShri Abhyankar /*
18602b4ed282SShri Abhyankar    SNESVISetVariableBounds - Sets the lower and upper bounds for the solution vector. xl <= x <= xu.
18612b4ed282SShri Abhyankar 
18622b4ed282SShri Abhyankar    Input Parameters:
18632b4ed282SShri Abhyankar .  snes - the SNES context.
18642b4ed282SShri Abhyankar .  xl   - lower bound.
18652b4ed282SShri Abhyankar .  xu   - upper bound.
18662b4ed282SShri Abhyankar 
18672b4ed282SShri Abhyankar    Notes:
18682b4ed282SShri Abhyankar    If this routine is not called then the lower and upper bounds are set to
186984c105d7SBarry Smith    PETSC_VI_INF and PETSC_VI_NINF respectively during SNESSetUp().
187084c105d7SBarry Smith 
18712b4ed282SShri Abhyankar */
18722b4ed282SShri Abhyankar 
18732b4ed282SShri Abhyankar #undef __FUNCT__
18742b4ed282SShri Abhyankar #define __FUNCT__ "SNESVISetVariableBounds"
187569c03620SShri Abhyankar PetscErrorCode SNESVISetVariableBounds(SNES snes, Vec xl, Vec xu)
18762b4ed282SShri Abhyankar {
18772b4ed282SShri Abhyankar   SNES_VI        *vi = (SNES_VI*)snes->data;
18782b4ed282SShri Abhyankar 
18792b4ed282SShri Abhyankar   PetscFunctionBegin;
18802b4ed282SShri Abhyankar   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
18812b4ed282SShri Abhyankar   PetscValidHeaderSpecific(xl,VEC_CLASSID,2);
18822b4ed282SShri Abhyankar   PetscValidHeaderSpecific(xu,VEC_CLASSID,3);
18832b4ed282SShri Abhyankar 
18842b4ed282SShri Abhyankar   /* Check if SNESSetFunction is called */
18852b4ed282SShri Abhyankar   if(!snes->vec_func) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call SNESSetFunction() first");
18862b4ed282SShri Abhyankar 
18872b4ed282SShri Abhyankar   /* Check if the vector sizes are compatible for lower and upper bounds */
18882b4ed282SShri 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);
18892b4ed282SShri 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);
18902b4ed282SShri Abhyankar   vi->usersetxbounds = PETSC_TRUE;
18912b4ed282SShri Abhyankar   vi->xl = xl;
18922b4ed282SShri Abhyankar   vi->xu = xu;
18932b4ed282SShri Abhyankar 
18942b4ed282SShri Abhyankar   PetscFunctionReturn(0);
18952b4ed282SShri Abhyankar }
18962b4ed282SShri Abhyankar /* -------------------------------------------------------------------------- */
18972b4ed282SShri Abhyankar /*
18982b4ed282SShri Abhyankar    SNESSetFromOptions_VI - Sets various parameters for the SNESVI method.
18992b4ed282SShri Abhyankar 
19002b4ed282SShri Abhyankar    Input Parameter:
19012b4ed282SShri Abhyankar .  snes - the SNES context
19022b4ed282SShri Abhyankar 
19032b4ed282SShri Abhyankar    Application Interface Routine: SNESSetFromOptions()
19042b4ed282SShri Abhyankar */
19052b4ed282SShri Abhyankar #undef __FUNCT__
19062b4ed282SShri Abhyankar #define __FUNCT__ "SNESSetFromOptions_VI"
19072b4ed282SShri Abhyankar static PetscErrorCode SNESSetFromOptions_VI(SNES snes)
19082b4ed282SShri Abhyankar {
19092b4ed282SShri Abhyankar   SNES_VI        *vi = (SNES_VI *)snes->data;
19102b4ed282SShri Abhyankar   const char     *lses[] = {"basic","basicnonorms","quadratic","cubic"};
1911d950fb63SShri Abhyankar   const char     *vies[] = {"ss","as","rs"};
19122b4ed282SShri Abhyankar   PetscErrorCode ierr;
19132b4ed282SShri Abhyankar   PetscInt       indx;
191469c03620SShri Abhyankar   PetscBool      flg,set,flg2;
19152b4ed282SShri Abhyankar 
19162b4ed282SShri Abhyankar   PetscFunctionBegin;
19172b4ed282SShri Abhyankar     ierr = PetscOptionsHead("SNES semismooth method options");CHKERRQ(ierr);
19189308c137SBarry Smith     ierr = PetscOptionsBool("-snes_vi_monitor","Monitor all non-active variables","None",PETSC_FALSE,&flg,0);CHKERRQ(ierr);
19199308c137SBarry Smith     if (flg) {
19209308c137SBarry Smith       ierr = SNESMonitorSet(snes,SNESMonitorVI,0,0);CHKERRQ(ierr);
19219308c137SBarry Smith     }
19222b4ed282SShri Abhyankar     ierr = PetscOptionsReal("-snes_vi_alpha","Function norm must decrease by","None",vi->alpha,&vi->alpha,0);CHKERRQ(ierr);
19232b4ed282SShri Abhyankar     ierr = PetscOptionsReal("-snes_vi_maxstep","Step must be less than","None",vi->maxstep,&vi->maxstep,0);CHKERRQ(ierr);
19242b4ed282SShri Abhyankar     ierr = PetscOptionsReal("-snes_vi_minlambda","Minimum lambda allowed","None",vi->minlambda,&vi->minlambda,0);CHKERRQ(ierr);
19252b4ed282SShri Abhyankar     ierr = PetscOptionsReal("-snes_vi_const_tol","constraint tolerance","None",vi->const_tol,&vi->const_tol,0);CHKERRQ(ierr);
1926acfcf0e5SJed Brown     ierr = PetscOptionsBool("-snes_vi_lsmonitor","Print progress of line searches","SNESLineSearchSetMonitor",vi->lsmonitor ? PETSC_TRUE : PETSC_FALSE,&flg,&set);CHKERRQ(ierr);
19272b4ed282SShri Abhyankar     if (set) {ierr = SNESLineSearchSetMonitor(snes,flg);CHKERRQ(ierr);}
1928d950fb63SShri Abhyankar     ierr = PetscOptionsEList("-snes_vi_type","Semismooth algorithm used","",vies,3,"ss",&indx,&flg2);CHKERRQ(ierr);
192969c03620SShri Abhyankar     if (flg2) {
193069c03620SShri Abhyankar       switch (indx) {
193169c03620SShri Abhyankar       case 0:
193269c03620SShri Abhyankar 	snes->ops->solve = SNESSolveVI_SS;
193369c03620SShri Abhyankar 	break;
193469c03620SShri Abhyankar       case 1:
193569c03620SShri Abhyankar 	snes->ops->solve = SNESSolveVI_AS;
193669c03620SShri Abhyankar 	break;
1937d950fb63SShri Abhyankar       case 2:
1938d950fb63SShri Abhyankar         snes->ops->solve = SNESSolveVI_RS;
1939d950fb63SShri Abhyankar         break;
194069c03620SShri Abhyankar       }
194169c03620SShri Abhyankar     }
1942c92abb8aSShri Abhyankar     ierr = PetscOptionsEList("-snes_vi_ls","Line search used","SNESLineSearchSet",lses,4,"cubic",&indx,&flg);CHKERRQ(ierr);
19432b4ed282SShri Abhyankar     if (flg) {
19442b4ed282SShri Abhyankar       switch (indx) {
19452b4ed282SShri Abhyankar       case 0:
19462b4ed282SShri Abhyankar         ierr = SNESLineSearchSet(snes,SNESLineSearchNo_VI,PETSC_NULL);CHKERRQ(ierr);
19472b4ed282SShri Abhyankar         break;
19482b4ed282SShri Abhyankar       case 1:
19492b4ed282SShri Abhyankar         ierr = SNESLineSearchSet(snes,SNESLineSearchNoNorms_VI,PETSC_NULL);CHKERRQ(ierr);
19502b4ed282SShri Abhyankar         break;
19512b4ed282SShri Abhyankar       case 2:
19522b4ed282SShri Abhyankar         ierr = SNESLineSearchSet(snes,SNESLineSearchQuadratic_VI,PETSC_NULL);CHKERRQ(ierr);
19532b4ed282SShri Abhyankar         break;
19542b4ed282SShri Abhyankar       case 3:
19552b4ed282SShri Abhyankar         ierr = SNESLineSearchSet(snes,SNESLineSearchCubic_VI,PETSC_NULL);CHKERRQ(ierr);
19562b4ed282SShri Abhyankar         break;
19572b4ed282SShri Abhyankar       }
19582b4ed282SShri Abhyankar     }
19592b4ed282SShri Abhyankar   ierr = PetscOptionsTail();CHKERRQ(ierr);
19602b4ed282SShri Abhyankar   PetscFunctionReturn(0);
19612b4ed282SShri Abhyankar }
19622b4ed282SShri Abhyankar /* -------------------------------------------------------------------------- */
19632b4ed282SShri Abhyankar /*MC
19642b4ed282SShri Abhyankar       SNESVI - Semismooth newton method based nonlinear solver that uses a line search
19652b4ed282SShri Abhyankar 
19662b4ed282SShri Abhyankar    Options Database:
19672b4ed282SShri Abhyankar +   -snes_vi [cubic,quadratic,basic,basicnonorms] - Selects line search
19682b4ed282SShri Abhyankar .   -snes_vi_alpha <alpha> - Sets alpha
19692b4ed282SShri 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)
19702b4ed282SShri Abhyankar .   -snes_vi_minlambda <minlambda>  - Sets the minimum lambda the line search will use  minlambda / max_i ( y[i]/x[i] )
19712b4ed282SShri Abhyankar -   -snes_vi_monitor - print information about progress of line searches
19722b4ed282SShri Abhyankar 
19732b4ed282SShri Abhyankar 
19742b4ed282SShri Abhyankar    Level: beginner
19752b4ed282SShri Abhyankar 
19762b4ed282SShri Abhyankar .seealso:  SNESCreate(), SNES, SNESSetType(), SNESTR, SNESLineSearchSet(),
19772b4ed282SShri Abhyankar            SNESLineSearchSetPostCheck(), SNESLineSearchNo(), SNESLineSearchCubic(), SNESLineSearchQuadratic(),
19782b4ed282SShri Abhyankar            SNESLineSearchSet(), SNESLineSearchNoNorms(), SNESLineSearchSetPreCheck(), SNESLineSearchSetParams(), SNESLineSearchGetParams()
19792b4ed282SShri Abhyankar 
19802b4ed282SShri Abhyankar M*/
19812b4ed282SShri Abhyankar EXTERN_C_BEGIN
19822b4ed282SShri Abhyankar #undef __FUNCT__
19832b4ed282SShri Abhyankar #define __FUNCT__ "SNESCreate_VI"
19842b4ed282SShri Abhyankar PetscErrorCode PETSCSNES_DLLEXPORT SNESCreate_VI(SNES snes)
19852b4ed282SShri Abhyankar {
19862b4ed282SShri Abhyankar   PetscErrorCode ierr;
19872b4ed282SShri Abhyankar   SNES_VI      *vi;
19882b4ed282SShri Abhyankar 
19892b4ed282SShri Abhyankar   PetscFunctionBegin;
19902b4ed282SShri Abhyankar   snes->ops->setup	     = SNESSetUp_VI;
199169c03620SShri Abhyankar   snes->ops->solve	     = SNESSolveVI_SS;
19922b4ed282SShri Abhyankar   snes->ops->destroy	     = SNESDestroy_VI;
19932b4ed282SShri Abhyankar   snes->ops->setfromoptions  = SNESSetFromOptions_VI;
19942b4ed282SShri Abhyankar   snes->ops->view            = SNESView_VI;
19952b4ed282SShri Abhyankar   snes->ops->converged       = SNESDefaultConverged_VI;
19962b4ed282SShri Abhyankar 
19972b4ed282SShri Abhyankar   ierr                   = PetscNewLog(snes,SNES_VI,&vi);CHKERRQ(ierr);
19982b4ed282SShri Abhyankar   snes->data    	 = (void*)vi;
19992b4ed282SShri Abhyankar   vi->alpha		 = 1.e-4;
20002b4ed282SShri Abhyankar   vi->maxstep		 = 1.e8;
20012b4ed282SShri Abhyankar   vi->minlambda         = 1.e-12;
20022b4ed282SShri Abhyankar   vi->LineSearch        = SNESLineSearchCubic_VI;
20032b4ed282SShri Abhyankar   vi->lsP               = PETSC_NULL;
20042b4ed282SShri Abhyankar   vi->postcheckstep     = PETSC_NULL;
20052b4ed282SShri Abhyankar   vi->postcheck         = PETSC_NULL;
20062b4ed282SShri Abhyankar   vi->precheckstep      = PETSC_NULL;
20072b4ed282SShri Abhyankar   vi->precheck          = PETSC_NULL;
20082b4ed282SShri Abhyankar   vi->const_tol         =  2.2204460492503131e-16;
20092b4ed282SShri Abhyankar   vi->computessfunction = ComputeFischerFunction;
20102b4ed282SShri Abhyankar 
20112b4ed282SShri Abhyankar   ierr = PetscObjectComposeFunctionDynamic((PetscObject)snes,"SNESLineSearchSetMonitor_C","SNESLineSearchSetMonitor_VI",SNESLineSearchSetMonitor_VI);CHKERRQ(ierr);
20122b4ed282SShri Abhyankar   ierr = PetscObjectComposeFunctionDynamic((PetscObject)snes,"SNESLineSearchSet_C","SNESLineSearchSet_VI",SNESLineSearchSet_VI);CHKERRQ(ierr);
20132b4ed282SShri Abhyankar 
20142b4ed282SShri Abhyankar   PetscFunctionReturn(0);
20152b4ed282SShri Abhyankar }
20162b4ed282SShri Abhyankar EXTERN_C_END
2017