xref: /petsc/src/snes/impls/vi/vi.c (revision 0a7c7af0fdde0699c320e89f00aa822e4d74ace5)
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 
62b4ed282SShri Abhyankar /*
72b4ed282SShri Abhyankar      Checks if J^T F = 0 which implies we've found a local minimum of the norm of the function,
82b4ed282SShri 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
92b4ed282SShri Abhyankar     0 = (J^T F)^T W = F^T J W iff W not in the null space of J. Thanks for Jorge More
102b4ed282SShri Abhyankar     for this trick. One assumes that the probability that W is in the null space of J is very, very small.
112b4ed282SShri Abhyankar */
122b4ed282SShri Abhyankar #undef __FUNCT__
132b4ed282SShri Abhyankar #define __FUNCT__ "SNESVICheckLocalMin_Private"
14ace3abfcSBarry Smith PetscErrorCode SNESVICheckLocalMin_Private(SNES snes,Mat A,Vec F,Vec W,PetscReal fnorm,PetscBool *ismin)
152b4ed282SShri Abhyankar {
162b4ed282SShri Abhyankar   PetscReal      a1;
172b4ed282SShri Abhyankar   PetscErrorCode ierr;
18ace3abfcSBarry Smith   PetscBool     hastranspose;
192b4ed282SShri Abhyankar 
202b4ed282SShri Abhyankar   PetscFunctionBegin;
212b4ed282SShri Abhyankar   *ismin = PETSC_FALSE;
222b4ed282SShri Abhyankar   ierr = MatHasOperation(A,MATOP_MULT_TRANSPOSE,&hastranspose);CHKERRQ(ierr);
232b4ed282SShri Abhyankar   if (hastranspose) {
242b4ed282SShri Abhyankar     /* Compute || J^T F|| */
252b4ed282SShri Abhyankar     ierr = MatMultTranspose(A,F,W);CHKERRQ(ierr);
262b4ed282SShri Abhyankar     ierr = VecNorm(W,NORM_2,&a1);CHKERRQ(ierr);
272b4ed282SShri Abhyankar     ierr = PetscInfo1(snes,"|| J^T F|| %G near zero implies found a local minimum\n",a1/fnorm);CHKERRQ(ierr);
282b4ed282SShri Abhyankar     if (a1/fnorm < 1.e-4) *ismin = PETSC_TRUE;
292b4ed282SShri Abhyankar   } else {
302b4ed282SShri Abhyankar     Vec         work;
312b4ed282SShri Abhyankar     PetscScalar result;
322b4ed282SShri Abhyankar     PetscReal   wnorm;
332b4ed282SShri Abhyankar 
342b4ed282SShri Abhyankar     ierr = VecSetRandom(W,PETSC_NULL);CHKERRQ(ierr);
352b4ed282SShri Abhyankar     ierr = VecNorm(W,NORM_2,&wnorm);CHKERRQ(ierr);
362b4ed282SShri Abhyankar     ierr = VecDuplicate(W,&work);CHKERRQ(ierr);
372b4ed282SShri Abhyankar     ierr = MatMult(A,W,work);CHKERRQ(ierr);
382b4ed282SShri Abhyankar     ierr = VecDot(F,work,&result);CHKERRQ(ierr);
392b4ed282SShri Abhyankar     ierr = VecDestroy(work);CHKERRQ(ierr);
402b4ed282SShri Abhyankar     a1   = PetscAbsScalar(result)/(fnorm*wnorm);
412b4ed282SShri Abhyankar     ierr = PetscInfo1(snes,"(F^T J random)/(|| F ||*||random|| %G near zero implies found a local minimum\n",a1);CHKERRQ(ierr);
422b4ed282SShri Abhyankar     if (a1 < 1.e-4) *ismin = PETSC_TRUE;
432b4ed282SShri Abhyankar   }
442b4ed282SShri Abhyankar   PetscFunctionReturn(0);
452b4ed282SShri Abhyankar }
462b4ed282SShri Abhyankar 
472b4ed282SShri Abhyankar /*
482b4ed282SShri Abhyankar      Checks if J^T(F - J*X) = 0
492b4ed282SShri Abhyankar */
502b4ed282SShri Abhyankar #undef __FUNCT__
512b4ed282SShri Abhyankar #define __FUNCT__ "SNESVICheckResidual_Private"
522b4ed282SShri Abhyankar PetscErrorCode SNESVICheckResidual_Private(SNES snes,Mat A,Vec F,Vec X,Vec W1,Vec W2)
532b4ed282SShri Abhyankar {
542b4ed282SShri Abhyankar   PetscReal      a1,a2;
552b4ed282SShri Abhyankar   PetscErrorCode ierr;
56ace3abfcSBarry Smith   PetscBool     hastranspose;
572b4ed282SShri Abhyankar 
582b4ed282SShri Abhyankar   PetscFunctionBegin;
592b4ed282SShri Abhyankar   ierr = MatHasOperation(A,MATOP_MULT_TRANSPOSE,&hastranspose);CHKERRQ(ierr);
602b4ed282SShri Abhyankar   if (hastranspose) {
612b4ed282SShri Abhyankar     ierr = MatMult(A,X,W1);CHKERRQ(ierr);
622b4ed282SShri Abhyankar     ierr = VecAXPY(W1,-1.0,F);CHKERRQ(ierr);
632b4ed282SShri Abhyankar 
642b4ed282SShri Abhyankar     /* Compute || J^T W|| */
652b4ed282SShri Abhyankar     ierr = MatMultTranspose(A,W1,W2);CHKERRQ(ierr);
662b4ed282SShri Abhyankar     ierr = VecNorm(W1,NORM_2,&a1);CHKERRQ(ierr);
672b4ed282SShri Abhyankar     ierr = VecNorm(W2,NORM_2,&a2);CHKERRQ(ierr);
682b4ed282SShri Abhyankar     if (a1 != 0.0) {
692b4ed282SShri Abhyankar       ierr = PetscInfo1(snes,"||J^T(F-Ax)||/||F-AX|| %G near zero implies inconsistent rhs\n",a2/a1);CHKERRQ(ierr);
702b4ed282SShri Abhyankar     }
712b4ed282SShri Abhyankar   }
722b4ed282SShri Abhyankar   PetscFunctionReturn(0);
732b4ed282SShri Abhyankar }
742b4ed282SShri Abhyankar 
752b4ed282SShri Abhyankar /*
762b4ed282SShri Abhyankar   SNESDefaultConverged_VI - Checks the convergence of the semismooth newton algorithm.
772b4ed282SShri Abhyankar 
782b4ed282SShri Abhyankar   Notes:
792b4ed282SShri Abhyankar   The convergence criterion currently implemented is
802b4ed282SShri Abhyankar   merit < abstol
812b4ed282SShri Abhyankar   merit < rtol*merit_initial
822b4ed282SShri Abhyankar */
832b4ed282SShri Abhyankar #undef __FUNCT__
842b4ed282SShri Abhyankar #define __FUNCT__ "SNESDefaultConverged_VI"
852b4ed282SShri Abhyankar PetscErrorCode SNESDefaultConverged_VI(SNES snes,PetscInt it,PetscReal xnorm,PetscReal gradnorm,PetscReal merit,SNESConvergedReason *reason,void *dummy)
862b4ed282SShri Abhyankar {
872b4ed282SShri Abhyankar   PetscErrorCode ierr;
882b4ed282SShri Abhyankar 
892b4ed282SShri Abhyankar   PetscFunctionBegin;
902b4ed282SShri Abhyankar   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
912b4ed282SShri Abhyankar   PetscValidPointer(reason,6);
922b4ed282SShri Abhyankar 
932b4ed282SShri Abhyankar   *reason = SNES_CONVERGED_ITERATING;
942b4ed282SShri Abhyankar 
952b4ed282SShri Abhyankar   if (!it) {
962b4ed282SShri Abhyankar     /* set parameter for default relative tolerance convergence test */
972b4ed282SShri Abhyankar     snes->ttol = merit*snes->rtol;
982b4ed282SShri Abhyankar   }
992b4ed282SShri Abhyankar   if (merit != merit) {
1002b4ed282SShri Abhyankar     ierr = PetscInfo(snes,"Failed to converged, function norm is NaN\n");CHKERRQ(ierr);
1012b4ed282SShri Abhyankar     *reason = SNES_DIVERGED_FNORM_NAN;
1022b4ed282SShri Abhyankar   } else if (merit < snes->abstol) {
1032b4ed282SShri Abhyankar     ierr = PetscInfo2(snes,"Converged due to merit function %G < %G\n",merit,snes->abstol);CHKERRQ(ierr);
1042b4ed282SShri Abhyankar     *reason = SNES_CONVERGED_FNORM_ABS;
1052b4ed282SShri Abhyankar   } else if (snes->nfuncs >= snes->max_funcs) {
1062b4ed282SShri Abhyankar     ierr = PetscInfo2(snes,"Exceeded maximum number of function evaluations: %D > %D\n",snes->nfuncs,snes->max_funcs);CHKERRQ(ierr);
1072b4ed282SShri Abhyankar     *reason = SNES_DIVERGED_FUNCTION_COUNT;
1082b4ed282SShri Abhyankar   }
1092b4ed282SShri Abhyankar 
1102b4ed282SShri Abhyankar   if (it && !*reason) {
1112b4ed282SShri Abhyankar     if (merit < snes->ttol) {
1122b4ed282SShri Abhyankar       ierr = PetscInfo2(snes,"Converged due to merit function %G < %G (relative tolerance)\n",merit,snes->ttol);CHKERRQ(ierr);
1132b4ed282SShri Abhyankar       *reason = SNES_CONVERGED_FNORM_RELATIVE;
1142b4ed282SShri Abhyankar     }
1152b4ed282SShri Abhyankar   }
1162b4ed282SShri Abhyankar   PetscFunctionReturn(0);
1172b4ed282SShri Abhyankar }
1182b4ed282SShri Abhyankar 
1192b4ed282SShri Abhyankar /*
1202b4ed282SShri Abhyankar   SNESVIComputeMeritFunction - Evaluates the merit function for the mixed complementarity problem.
1212b4ed282SShri Abhyankar 
1222b4ed282SShri Abhyankar   Input Parameter:
1232b4ed282SShri Abhyankar . phi - the semismooth function
1242b4ed282SShri Abhyankar 
1252b4ed282SShri Abhyankar   Output Parameter:
1262b4ed282SShri Abhyankar . merit - the merit function
1272b4ed282SShri Abhyankar . phinorm - ||phi||
1282b4ed282SShri Abhyankar 
1292b4ed282SShri Abhyankar   Notes:
1302b4ed282SShri Abhyankar   The merit function for the mixed complementarity problem is defined as
1312b4ed282SShri Abhyankar      merit = 0.5*phi^T*phi
1322b4ed282SShri Abhyankar */
1332b4ed282SShri Abhyankar #undef __FUNCT__
1342b4ed282SShri Abhyankar #define __FUNCT__ "SNESVIComputeMeritFunction"
1352b4ed282SShri Abhyankar static PetscErrorCode SNESVIComputeMeritFunction(Vec phi, PetscReal* merit,PetscReal* phinorm)
1362b4ed282SShri Abhyankar {
1372b4ed282SShri Abhyankar   PetscErrorCode ierr;
1382b4ed282SShri Abhyankar 
1392b4ed282SShri Abhyankar   PetscFunctionBegin;
1402b4ed282SShri Abhyankar   ierr = VecNormBegin(phi,NORM_2,phinorm);
1412b4ed282SShri Abhyankar   ierr = VecNormEnd(phi,NORM_2,phinorm);
1422b4ed282SShri Abhyankar 
1432b4ed282SShri Abhyankar   *merit = 0.5*(*phinorm)*(*phinorm);
1442b4ed282SShri Abhyankar   PetscFunctionReturn(0);
1452b4ed282SShri Abhyankar }
1462b4ed282SShri Abhyankar 
1472b4ed282SShri Abhyankar /*
1482b4ed282SShri Abhyankar   ComputeFischerFunction - Computes the semismooth fischer burmeister function for a mixed complementarity equation.
1492b4ed282SShri Abhyankar 
1502b4ed282SShri Abhyankar   Notes:
1512b4ed282SShri Abhyankar   The Fischer-Burmeister function is defined as
1522b4ed282SShri Abhyankar        ff(a,b) := sqrt(a*a + b*b) - a - b
1532b4ed282SShri Abhyankar   and is used reformulate a complementarity equation  as a semismooth equation.
1542b4ed282SShri Abhyankar */
1552b4ed282SShri Abhyankar 
1562b4ed282SShri Abhyankar #undef __FUNCT__
1572b4ed282SShri Abhyankar #define __FUNCT__ "ComputeFischerFunction"
1582b4ed282SShri Abhyankar static PetscErrorCode ComputeFischerFunction(PetscScalar a, PetscScalar b, PetscScalar* ff)
1592b4ed282SShri Abhyankar {
1602b4ed282SShri Abhyankar   PetscFunctionBegin;
1612b4ed282SShri Abhyankar   *ff = sqrt(a*a + b*b) - a - b;
1622b4ed282SShri Abhyankar   PetscFunctionReturn(0);
1632b4ed282SShri Abhyankar }
1642b4ed282SShri Abhyankar 
1652b4ed282SShri Abhyankar /*
1661f79c099SShri Abhyankar    SNESVIComputeFunction - Reformulates a system of nonlinear equations in mixed complementarity form to a system of nonlinear equations in semismooth form.
1672b4ed282SShri Abhyankar 
1682b4ed282SShri Abhyankar    Input Parameters:
1692b4ed282SShri Abhyankar .  snes - the SNES context
1702b4ed282SShri Abhyankar .  x - current iterate
1712b4ed282SShri Abhyankar .  functx - user defined function context
1722b4ed282SShri Abhyankar 
1732b4ed282SShri Abhyankar    Output Parameters:
1742b4ed282SShri Abhyankar .  phi - Semismooth function
1752b4ed282SShri Abhyankar 
1762b4ed282SShri Abhyankar    Notes:
1772b4ed282SShri Abhyankar    The result of this function is done by cases:
1782b4ed282SShri Abhyankar +  l[i] == -infinity, u[i] == infinity  -- phi[i] = -f[i]
1792b4ed282SShri Abhyankar .  l[i] == -infinity, u[i] finite       -- phi[i] = ss(u[i]-x[i], -f[i])
1802b4ed282SShri Abhyankar .  l[i] finite,       u[i] == infinity  -- phi[i] = ss(x[i]-l[i],  f[i])
1812b4ed282SShri Abhyankar .  l[i] finite < u[i] finite -- phi[i] = phi(x[i]-l[i], ss(u[i]-x[i], -f[u]))
1822b4ed282SShri Abhyankar -  otherwise l[i] == u[i] -- phi[i] = l[i] - x[i]
1832b4ed282SShri Abhyankar    ss is the semismoothing function used to reformulate the nonlinear equation in complementarity
1842b4ed282SShri Abhyankar    form to semismooth form
1852b4ed282SShri Abhyankar 
1862b4ed282SShri Abhyankar */
1872b4ed282SShri Abhyankar #undef __FUNCT__
1881f79c099SShri Abhyankar #define __FUNCT__ "SNESVIComputeFunction"
1891f79c099SShri Abhyankar static PetscErrorCode SNESVIComputeFunction(SNES snes,Vec X,Vec phi,void* functx)
1902b4ed282SShri Abhyankar {
1912b4ed282SShri Abhyankar   PetscErrorCode  ierr;
1922b4ed282SShri Abhyankar   SNES_VI       *vi = (SNES_VI*)snes->data;
1932b4ed282SShri Abhyankar   Vec             Xl = vi->xl,Xu = vi->xu,F = snes->vec_func;
1942b4ed282SShri Abhyankar   PetscScalar     *phi_arr,*x_arr,*f_arr,*l,*u,t;
1952b4ed282SShri Abhyankar   PetscInt        i,nlocal;
1962b4ed282SShri Abhyankar 
1972b4ed282SShri Abhyankar   PetscFunctionBegin;
1982b4ed282SShri Abhyankar   ierr = (*vi->computeuserfunction)(snes,X,F,functx);CHKERRQ(ierr);
1992b4ed282SShri Abhyankar   ierr = VecGetLocalSize(X,&nlocal);CHKERRQ(ierr);
2002b4ed282SShri Abhyankar 
2012b4ed282SShri Abhyankar   ierr = VecGetArray(X,&x_arr);CHKERRQ(ierr);
2022b4ed282SShri Abhyankar   ierr = VecGetArray(F,&f_arr);CHKERRQ(ierr);
2032b4ed282SShri Abhyankar   ierr = VecGetArray(Xl,&l);CHKERRQ(ierr);
2042b4ed282SShri Abhyankar   ierr = VecGetArray(Xu,&u);CHKERRQ(ierr);
2052b4ed282SShri Abhyankar   ierr = VecGetArray(phi,&phi_arr);CHKERRQ(ierr);
2062b4ed282SShri Abhyankar 
2072b4ed282SShri Abhyankar   for (i=0;i < nlocal;i++) {
2082b4ed282SShri Abhyankar     if ((l[i] <= PETSC_VI_NINF) && (u[i] >= PETSC_VI_INF)) {
2092b4ed282SShri Abhyankar       phi_arr[i] = -f_arr[i];
2102b4ed282SShri Abhyankar     }
2112b4ed282SShri Abhyankar     else if (l[i] <= PETSC_VI_NINF) {
2122b4ed282SShri Abhyankar       t = u[i] - x_arr[i];
2132b4ed282SShri Abhyankar       ierr = ComputeFischerFunction(t,-f_arr[i],&phi_arr[i]);CHKERRQ(ierr);
2142b4ed282SShri Abhyankar       phi_arr[i] = -phi_arr[i];
2152b4ed282SShri Abhyankar     }
2162b4ed282SShri Abhyankar     else if (u[i] >= PETSC_VI_INF) {
2172b4ed282SShri Abhyankar       t = x_arr[i] - l[i];
2182b4ed282SShri Abhyankar       ierr = ComputeFischerFunction(t,f_arr[i],&phi_arr[i]);CHKERRQ(ierr);
2192b4ed282SShri Abhyankar     }
2202b4ed282SShri Abhyankar     else if (l[i] == u[i]) {
2212b4ed282SShri Abhyankar       phi_arr[i] = l[i] - x_arr[i];
2222b4ed282SShri Abhyankar     }
2232b4ed282SShri Abhyankar     else {
2242b4ed282SShri Abhyankar       t = u[i] - x_arr[i];
2252b4ed282SShri Abhyankar       ierr = ComputeFischerFunction(t,-f_arr[i],&phi_arr[i]);
2262b4ed282SShri Abhyankar       t = x_arr[i] - l[i];
2272b4ed282SShri Abhyankar       ierr = ComputeFischerFunction(t,phi_arr[i],&phi_arr[i]);
2282b4ed282SShri Abhyankar     }
2292b4ed282SShri Abhyankar   }
2302b4ed282SShri Abhyankar 
2312b4ed282SShri Abhyankar   ierr = VecRestoreArray(X,&x_arr);CHKERRQ(ierr);
2322b4ed282SShri Abhyankar   ierr = VecRestoreArray(F,&f_arr);CHKERRQ(ierr);
2332b4ed282SShri Abhyankar   ierr = VecRestoreArray(Xl,&l);CHKERRQ(ierr);
2342b4ed282SShri Abhyankar   ierr = VecRestoreArray(Xu,&u);CHKERRQ(ierr);
2352b4ed282SShri Abhyankar   ierr = VecRestoreArray(phi,&phi_arr);CHKERRQ(ierr);
2362b4ed282SShri Abhyankar 
2372b4ed282SShri Abhyankar   PetscFunctionReturn(0);
2382b4ed282SShri Abhyankar }
2392b4ed282SShri Abhyankar 
2402b4ed282SShri Abhyankar /*
241a79edbefSShri Abhyankar    SNESVIComputeBsubdifferentialVectors - Computes the diagonal shift (Da) and row scaling (Db) vectors needed for the
242a79edbefSShri Abhyankar                                           the semismooth jacobian.
2432b4ed282SShri Abhyankar */
2442b4ed282SShri Abhyankar #undef __FUNCT__
245a79edbefSShri Abhyankar #define __FUNCT__ "SNESVIComputeBsubdifferentialVectors"
246a79edbefSShri Abhyankar PetscErrorCode SNESVIComputeBsubdifferentialVectors(SNES snes,Vec X,Vec F,Mat jac,Vec Da,Vec Db)
2472b4ed282SShri Abhyankar {
2482b4ed282SShri Abhyankar   PetscErrorCode ierr;
2492b4ed282SShri Abhyankar   SNES_VI      *vi = (SNES_VI*)snes->data;
2502b4ed282SShri Abhyankar   PetscScalar    *l,*u,*x,*f,*da,*db,*z,*t,t1,t2,ci,di,ei;
2512b4ed282SShri Abhyankar   PetscInt       i,nlocal;
2522b4ed282SShri Abhyankar 
2532b4ed282SShri Abhyankar   PetscFunctionBegin;
2542b4ed282SShri Abhyankar 
2552b4ed282SShri Abhyankar   ierr = VecGetArray(X,&x);CHKERRQ(ierr);
2562b4ed282SShri Abhyankar   ierr = VecGetArray(F,&f);CHKERRQ(ierr);
2572b4ed282SShri Abhyankar   ierr = VecGetArray(vi->xl,&l);CHKERRQ(ierr);
2582b4ed282SShri Abhyankar   ierr = VecGetArray(vi->xu,&u);CHKERRQ(ierr);
259a79edbefSShri Abhyankar   ierr = VecGetArray(Da,&da);CHKERRQ(ierr);
260a79edbefSShri Abhyankar   ierr = VecGetArray(Db,&db);CHKERRQ(ierr);
2612b4ed282SShri Abhyankar   ierr = VecGetArray(vi->z,&z);CHKERRQ(ierr);
2622b4ed282SShri Abhyankar 
2632b4ed282SShri Abhyankar   ierr = VecGetLocalSize(X,&nlocal);CHKERRQ(ierr);
2642b4ed282SShri Abhyankar   /* Set the elements of the vector z:
2652b4ed282SShri Abhyankar      z[i] = 1 if (x[i] - l[i],f[i]) = (0,0) or (u[i] - x[i],f[i]) = (0,0)
2662b4ed282SShri Abhyankar      else z[i] = 0
2672b4ed282SShri Abhyankar   */
2682b4ed282SShri Abhyankar   for(i=0;i < nlocal;i++) {
2692b4ed282SShri Abhyankar     da[i] = db[i] = z[i] = 0;
2702b4ed282SShri Abhyankar     if(PetscAbsScalar(f[i]) <= vi->const_tol) {
2712b4ed282SShri Abhyankar       if ((l[i] > PETSC_VI_NINF) && (PetscAbsScalar(x[i]-l[i]) <= vi->const_tol)) {
2722b4ed282SShri Abhyankar 	da[i] = 1;
2732b4ed282SShri Abhyankar 	z[i]  = 1;
2742b4ed282SShri Abhyankar       }
2752b4ed282SShri Abhyankar       if ((u[i] < PETSC_VI_INF) && (PetscAbsScalar(u[i]-x[i]) <= vi->const_tol)) {
2762b4ed282SShri Abhyankar 	db[i] = 1;
2772b4ed282SShri Abhyankar 	z[i]  = 1;
2782b4ed282SShri Abhyankar       }
2792b4ed282SShri Abhyankar     }
2802b4ed282SShri Abhyankar   }
2812b4ed282SShri Abhyankar   ierr = VecRestoreArray(vi->z,&z);CHKERRQ(ierr);
282a79edbefSShri Abhyankar   ierr = MatMult(jac,vi->z,vi->t);CHKERRQ(ierr);
2832b4ed282SShri Abhyankar   ierr = VecGetArray(vi->t,&t);CHKERRQ(ierr);
2842b4ed282SShri Abhyankar   /* Compute the elements of the diagonal perturbation vector Da and row scaling vector Db */
2852b4ed282SShri Abhyankar   for(i=0;i< nlocal;i++) {
2862b4ed282SShri Abhyankar     /* Free variables */
2872b4ed282SShri Abhyankar     if ((l[i] <= PETSC_VI_NINF) && (u[i] >= PETSC_VI_INF)) {
2882b4ed282SShri Abhyankar       da[i] = 0; db[i] = -1;
2892b4ed282SShri Abhyankar     }
2902b4ed282SShri Abhyankar     /* lower bounded variables */
2912b4ed282SShri Abhyankar     else if (u[i] >= PETSC_VI_INF) {
2922b4ed282SShri Abhyankar       if (da[i] >= 1) {
2932b4ed282SShri Abhyankar 	t2 = PetscScalarNorm(1,t[i]);
2942b4ed282SShri Abhyankar 	da[i] = 1/t2 - 1;
2952b4ed282SShri Abhyankar 	db[i] = t[i]/t2 - 1;
2962b4ed282SShri Abhyankar       } else {
2972b4ed282SShri Abhyankar 	t1 = x[i] - l[i];
2982b4ed282SShri Abhyankar 	t2 = PetscScalarNorm(t1,f[i]);
2992b4ed282SShri Abhyankar 	da[i] = t1/t2 - 1;
3002b4ed282SShri Abhyankar 	db[i] = f[i]/t2 - 1;
3012b4ed282SShri Abhyankar       }
3022b4ed282SShri Abhyankar     }
3032b4ed282SShri Abhyankar     /* upper bounded variables */
3042b4ed282SShri Abhyankar     else if (l[i] <= PETSC_VI_NINF) {
3052b4ed282SShri Abhyankar       if (db[i] >= 1) {
3062b4ed282SShri Abhyankar 	t2 = PetscScalarNorm(1,t[i]);
3072b4ed282SShri Abhyankar 	da[i] = -1/t2 -1;
3082b4ed282SShri Abhyankar 	db[i] = -t[i]/t2 - 1;
3092b4ed282SShri Abhyankar       }
3102b4ed282SShri Abhyankar       else {
3112b4ed282SShri Abhyankar 	t1 = u[i] - x[i];
3122b4ed282SShri Abhyankar 	t2 = PetscScalarNorm(t1,f[i]);
3132b4ed282SShri Abhyankar 	da[i] = t1/t2 - 1;
3142b4ed282SShri Abhyankar 	db[i] = -f[i]/t2 - 1;
3152b4ed282SShri Abhyankar       }
3162b4ed282SShri Abhyankar     }
3172b4ed282SShri Abhyankar     /* Fixed variables */
3182b4ed282SShri Abhyankar     else if (l[i] == u[i]) {
3192b4ed282SShri Abhyankar       da[i] = -1;
3202b4ed282SShri Abhyankar       db[i] = 0;
3212b4ed282SShri Abhyankar     }
3222b4ed282SShri Abhyankar     /* Box constrained variables */
3232b4ed282SShri Abhyankar     else {
3242b4ed282SShri Abhyankar       if (db[i] >= 1) {
3252b4ed282SShri Abhyankar 	t2 = PetscScalarNorm(1,t[i]);
3262b4ed282SShri Abhyankar 	ci = 1/t2 + 1;
3272b4ed282SShri Abhyankar 	di = t[i]/t2 + 1;
3282b4ed282SShri Abhyankar       }
3292b4ed282SShri Abhyankar       else {
3302b4ed282SShri Abhyankar 	t1 = x[i] - u[i];
3312b4ed282SShri Abhyankar 	t2 = PetscScalarNorm(t1,f[i]);
3322b4ed282SShri Abhyankar 	ci = t1/t2 + 1;
3332b4ed282SShri Abhyankar 	di = f[i]/t2 + 1;
3342b4ed282SShri Abhyankar       }
3352b4ed282SShri Abhyankar 
3362b4ed282SShri Abhyankar       if (da[i] >= 1) {
3372b4ed282SShri Abhyankar 	t1 = ci + di*t[i];
3382b4ed282SShri Abhyankar 	t2 = PetscScalarNorm(1,t1);
3392b4ed282SShri Abhyankar 	t1 = t1/t2 - 1;
3402b4ed282SShri Abhyankar 	t2 = 1/t2  - 1;
3412b4ed282SShri Abhyankar       }
3422b4ed282SShri Abhyankar       else {
3432b4ed282SShri Abhyankar 	ierr = ComputeFischerFunction(u[i]-x[i],-f[i],&ei);CHKERRQ(ierr);
3442b4ed282SShri Abhyankar 	t2 = PetscScalarNorm(x[i]-l[i],ei);
3452b4ed282SShri Abhyankar 	t1 = ei/t2 - 1;
3462b4ed282SShri Abhyankar 	t2 = (x[i] - l[i])/t2 - 1;
3472b4ed282SShri Abhyankar       }
3482b4ed282SShri Abhyankar 
3492b4ed282SShri Abhyankar       da[i] = t2 + t1*ci;
3502b4ed282SShri Abhyankar       db[i] = t1*di;
3512b4ed282SShri Abhyankar     }
3522b4ed282SShri Abhyankar   }
3532b4ed282SShri Abhyankar   ierr = VecRestoreArray(X,&x);CHKERRQ(ierr);
3542b4ed282SShri Abhyankar   ierr = VecRestoreArray(F,&f);CHKERRQ(ierr);
3552b4ed282SShri Abhyankar   ierr = VecRestoreArray(vi->xl,&l);CHKERRQ(ierr);
3562b4ed282SShri Abhyankar   ierr = VecRestoreArray(vi->xu,&u);CHKERRQ(ierr);
357a79edbefSShri Abhyankar   ierr = VecRestoreArray(Da,&da);CHKERRQ(ierr);
358a79edbefSShri Abhyankar   ierr = VecRestoreArray(Db,&db);CHKERRQ(ierr);
3592b4ed282SShri Abhyankar   ierr = VecRestoreArray(vi->t,&t);CHKERRQ(ierr);
3602b4ed282SShri Abhyankar 
361a79edbefSShri Abhyankar   PetscFunctionReturn(0);
362a79edbefSShri Abhyankar }
363a79edbefSShri Abhyankar 
364a79edbefSShri Abhyankar /*
365a79edbefSShri 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.
366a79edbefSShri Abhyankar 
367a79edbefSShri Abhyankar    Input Parameters:
368a79edbefSShri Abhyankar .  Da       - Diagonal shift vector for the semismooth jacobian.
369a79edbefSShri Abhyankar .  Db       - Row scaling vector for the semismooth jacobian.
370a79edbefSShri Abhyankar 
371a79edbefSShri Abhyankar    Output Parameters:
372a79edbefSShri Abhyankar .  jac      - semismooth jacobian
373a79edbefSShri Abhyankar .  jac_pre  - optional preconditioning matrix
374a79edbefSShri Abhyankar 
375a79edbefSShri Abhyankar    Notes:
376a79edbefSShri Abhyankar    The semismooth jacobian matrix is given by
377a79edbefSShri Abhyankar    jac = Da + Db*jacfun
378a79edbefSShri Abhyankar    where Db is the row scaling matrix stored as a vector,
379a79edbefSShri Abhyankar          Da is the diagonal perturbation matrix stored as a vector
380a79edbefSShri Abhyankar    and   jacfun is the jacobian of the original nonlinear function.
381a79edbefSShri Abhyankar */
382a79edbefSShri Abhyankar #undef __FUNCT__
383a79edbefSShri Abhyankar #define __FUNCT__ "SNESVIComputeJacobian"
384a79edbefSShri Abhyankar PetscErrorCode SNESVIComputeJacobian(Mat jac, Mat jac_pre,Vec Da, Vec Db)
385a79edbefSShri Abhyankar {
386a79edbefSShri Abhyankar   PetscErrorCode ierr;
387a79edbefSShri Abhyankar 
3882b4ed282SShri Abhyankar   /* Do row scaling  and add diagonal perturbation */
389a79edbefSShri Abhyankar   ierr = MatDiagonalScale(jac,Db,PETSC_NULL);CHKERRQ(ierr);
390a79edbefSShri Abhyankar   ierr = MatDiagonalSet(jac,Da,ADD_VALUES);CHKERRQ(ierr);
391a79edbefSShri Abhyankar   if (jac != jac_pre) { /* If jac and jac_pre are different */
392a79edbefSShri Abhyankar     ierr = MatDiagonalScale(jac_pre,Db,PETSC_NULL);
393a79edbefSShri Abhyankar     ierr = MatDiagonalSet(jac_pre,Da,ADD_VALUES);CHKERRQ(ierr);
3942b4ed282SShri Abhyankar   }
3952b4ed282SShri Abhyankar   PetscFunctionReturn(0);
3962b4ed282SShri Abhyankar }
3972b4ed282SShri Abhyankar 
3982b4ed282SShri Abhyankar /*
3992b4ed282SShri Abhyankar    SNESVIAdjustInitialGuess - Readjusts the initial guess to the SNES solver supplied by the user so that the initial guess lies inside the feasible region .
4002b4ed282SShri Abhyankar 
4012b4ed282SShri Abhyankar    Input Parameters:
4022b4ed282SShri Abhyankar .  lb - lower bound.
4032b4ed282SShri Abhyankar .  ub - upper bound.
4042b4ed282SShri Abhyankar 
4052b4ed282SShri Abhyankar    Output Parameters:
4062b4ed282SShri Abhyankar .  X - the readjusted initial guess.
4072b4ed282SShri Abhyankar 
4082b4ed282SShri Abhyankar    Notes:
4092b4ed282SShri Abhyankar    The readjusted initial guess X[i] = max(max(min(l[i],X[i]),min(X[i],u[i])),min(l[i],u[i]))
4102b4ed282SShri Abhyankar */
4112b4ed282SShri Abhyankar #undef __FUNCT__
4122b4ed282SShri Abhyankar #define __FUNCT__ "SNESVIAdjustInitialGuess"
4132b4ed282SShri Abhyankar PetscErrorCode SNESVIAdjustInitialGuess(Vec X, Vec lb, Vec ub)
4142b4ed282SShri Abhyankar {
4152b4ed282SShri Abhyankar   PetscErrorCode ierr;
4162b4ed282SShri Abhyankar   PetscInt       i,nlocal;
4172b4ed282SShri Abhyankar   PetscScalar    *x,*l,*u;
4182b4ed282SShri Abhyankar 
4192b4ed282SShri Abhyankar   PetscFunctionBegin;
4202b4ed282SShri Abhyankar 
4212b4ed282SShri Abhyankar   ierr = VecGetLocalSize(X,&nlocal);CHKERRQ(ierr);
4222b4ed282SShri Abhyankar   ierr = VecGetArray(X,&x);CHKERRQ(ierr);
4232b4ed282SShri Abhyankar   ierr = VecGetArray(lb,&l);CHKERRQ(ierr);
4242b4ed282SShri Abhyankar   ierr = VecGetArray(ub,&u);CHKERRQ(ierr);
4252b4ed282SShri Abhyankar 
4262b4ed282SShri Abhyankar   for(i = 0; i < nlocal; i++) {
4272b4ed282SShri Abhyankar     x[i] = PetscMax(PetscMax(PetscMin(x[i],l[i]),PetscMin(x[i],u[i])),PetscMin(l[i],u[i]));
4282b4ed282SShri Abhyankar   }
4292b4ed282SShri Abhyankar 
4302b4ed282SShri Abhyankar   ierr = VecRestoreArray(X,&x);CHKERRQ(ierr);
4312b4ed282SShri Abhyankar   ierr = VecRestoreArray(lb,&l);CHKERRQ(ierr);
4322b4ed282SShri Abhyankar   ierr = VecRestoreArray(ub,&u);CHKERRQ(ierr);
4332b4ed282SShri Abhyankar 
4342b4ed282SShri Abhyankar   PetscFunctionReturn(0);
4352b4ed282SShri Abhyankar }
4362b4ed282SShri Abhyankar 
4372b4ed282SShri Abhyankar /*  --------------------------------------------------------------------
4382b4ed282SShri Abhyankar 
4392b4ed282SShri Abhyankar      This file implements a semismooth truncated Newton method with a line search,
4402b4ed282SShri Abhyankar      for solving a system of nonlinear equations in complementarity form, using the KSP, Vec,
4412b4ed282SShri Abhyankar      and Mat interfaces for linear solvers, vectors, and matrices,
4422b4ed282SShri Abhyankar      respectively.
4432b4ed282SShri Abhyankar 
4442b4ed282SShri Abhyankar      The following basic routines are required for each nonlinear solver:
4452b4ed282SShri Abhyankar           SNESCreate_XXX()          - Creates a nonlinear solver context
4462b4ed282SShri Abhyankar           SNESSetFromOptions_XXX()  - Sets runtime options
4472b4ed282SShri Abhyankar           SNESSolve_XXX()           - Solves the nonlinear system
4482b4ed282SShri Abhyankar           SNESDestroy_XXX()         - Destroys the nonlinear solver context
4492b4ed282SShri Abhyankar      The suffix "_XXX" denotes a particular implementation, in this case
4502b4ed282SShri Abhyankar      we use _VI (e.g., SNESCreate_VI, SNESSolve_VI) for solving
4512b4ed282SShri Abhyankar      systems of nonlinear equations with a line search (LS) method.
4522b4ed282SShri Abhyankar      These routines are actually called via the common user interface
4532b4ed282SShri Abhyankar      routines SNESCreate(), SNESSetFromOptions(), SNESSolve(), and
4542b4ed282SShri Abhyankar      SNESDestroy(), so the application code interface remains identical
4552b4ed282SShri Abhyankar      for all nonlinear solvers.
4562b4ed282SShri Abhyankar 
4572b4ed282SShri Abhyankar      Another key routine is:
4582b4ed282SShri Abhyankar           SNESSetUp_XXX()           - Prepares for the use of a nonlinear solver
4592b4ed282SShri Abhyankar      by setting data structures and options.   The interface routine SNESSetUp()
4602b4ed282SShri Abhyankar      is not usually called directly by the user, but instead is called by
4612b4ed282SShri Abhyankar      SNESSolve() if necessary.
4622b4ed282SShri Abhyankar 
4632b4ed282SShri Abhyankar      Additional basic routines are:
4642b4ed282SShri Abhyankar           SNESView_XXX()            - Prints details of runtime options that
4652b4ed282SShri Abhyankar                                       have actually been used.
4662b4ed282SShri Abhyankar      These are called by application codes via the interface routines
4672b4ed282SShri Abhyankar      SNESView().
4682b4ed282SShri Abhyankar 
4692b4ed282SShri Abhyankar      The various types of solvers (preconditioners, Krylov subspace methods,
4702b4ed282SShri Abhyankar      nonlinear solvers, timesteppers) are all organized similarly, so the
4712b4ed282SShri Abhyankar      above description applies to these categories also.
4722b4ed282SShri Abhyankar 
4732b4ed282SShri Abhyankar     -------------------------------------------------------------------- */
4742b4ed282SShri Abhyankar /*
47569c03620SShri Abhyankar    SNESSolveVI_SS - Solves the complementarity problem with a semismooth Newton
4762b4ed282SShri Abhyankar    method using a line search.
4772b4ed282SShri Abhyankar 
4782b4ed282SShri Abhyankar    Input Parameters:
4792b4ed282SShri Abhyankar .  snes - the SNES context
4802b4ed282SShri Abhyankar 
4812b4ed282SShri Abhyankar    Output Parameter:
4822b4ed282SShri Abhyankar .  outits - number of iterations until termination
4832b4ed282SShri Abhyankar 
4842b4ed282SShri Abhyankar    Application Interface Routine: SNESSolve()
4852b4ed282SShri Abhyankar 
4862b4ed282SShri Abhyankar    Notes:
4872b4ed282SShri Abhyankar    This implements essentially a semismooth Newton method with a
4882b4ed282SShri Abhyankar    line search.  By default a cubic backtracking line search
4892b4ed282SShri Abhyankar    is employed, as described in the text "Numerical Methods for
4902b4ed282SShri Abhyankar    Unconstrained Optimization and Nonlinear Equations" by Dennis
4912b4ed282SShri Abhyankar    and Schnabel.
4922b4ed282SShri Abhyankar */
4932b4ed282SShri Abhyankar #undef __FUNCT__
49469c03620SShri Abhyankar #define __FUNCT__ "SNESSolveVI_SS"
49569c03620SShri Abhyankar PetscErrorCode SNESSolveVI_SS(SNES snes)
4962b4ed282SShri Abhyankar {
4972b4ed282SShri Abhyankar   SNES_VI            *vi = (SNES_VI*)snes->data;
4982b4ed282SShri Abhyankar   PetscErrorCode     ierr;
4992b4ed282SShri Abhyankar   PetscInt           maxits,i,lits;
5003b336b49SShri Abhyankar   PetscBool          lssucceed;
5012b4ed282SShri Abhyankar   MatStructure       flg = DIFFERENT_NONZERO_PATTERN;
5022b4ed282SShri Abhyankar   PetscReal          gnorm,xnorm=0,ynorm;
5032b4ed282SShri Abhyankar   Vec                Y,X,F,G,W;
5042b4ed282SShri Abhyankar   KSPConvergedReason kspreason;
5052b4ed282SShri Abhyankar 
5062b4ed282SShri Abhyankar   PetscFunctionBegin;
5072b4ed282SShri Abhyankar   snes->numFailures            = 0;
5082b4ed282SShri Abhyankar   snes->numLinearSolveFailures = 0;
5092b4ed282SShri Abhyankar   snes->reason                 = SNES_CONVERGED_ITERATING;
5102b4ed282SShri Abhyankar 
5112b4ed282SShri Abhyankar   maxits	= snes->max_its;	/* maximum number of iterations */
5122b4ed282SShri Abhyankar   X		= snes->vec_sol;	/* solution vector */
5132b4ed282SShri Abhyankar   F		= snes->vec_func;	/* residual vector */
5142b4ed282SShri Abhyankar   Y		= snes->work[0];	/* work vectors */
5152b4ed282SShri Abhyankar   G		= snes->work[1];
5162b4ed282SShri Abhyankar   W		= snes->work[2];
5172b4ed282SShri Abhyankar 
5182b4ed282SShri Abhyankar   ierr = PetscObjectTakeAccess(snes);CHKERRQ(ierr);
5192b4ed282SShri Abhyankar   snes->iter = 0;
5202b4ed282SShri Abhyankar   snes->norm = 0.0;
5212b4ed282SShri Abhyankar   ierr = PetscObjectGrantAccess(snes);CHKERRQ(ierr);
5222b4ed282SShri Abhyankar 
5232b4ed282SShri Abhyankar   ierr = SNESVIAdjustInitialGuess(X,vi->xl,vi->xu);CHKERRQ(ierr);
5242b4ed282SShri Abhyankar   ierr = SNESComputeFunction(snes,X,vi->phi);CHKERRQ(ierr);
5252b4ed282SShri Abhyankar   if (snes->domainerror) {
5262b4ed282SShri Abhyankar     snes->reason = SNES_DIVERGED_FUNCTION_DOMAIN;
5272b4ed282SShri Abhyankar     PetscFunctionReturn(0);
5282b4ed282SShri Abhyankar   }
5292b4ed282SShri Abhyankar    /* Compute Merit function */
5302b4ed282SShri Abhyankar   ierr = SNESVIComputeMeritFunction(vi->phi,&vi->merit,&vi->phinorm);CHKERRQ(ierr);
5312b4ed282SShri Abhyankar 
5322b4ed282SShri Abhyankar   ierr = VecNormBegin(X,NORM_2,&xnorm);CHKERRQ(ierr);	/* xnorm <- ||x||  */
5332b4ed282SShri Abhyankar   ierr = VecNormEnd(X,NORM_2,&xnorm);CHKERRQ(ierr);
5342b4ed282SShri Abhyankar   if PetscIsInfOrNanReal(vi->merit) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FP,"User provided compute function generated a Not-a-Number");
5352b4ed282SShri Abhyankar 
5362b4ed282SShri Abhyankar   ierr = PetscObjectTakeAccess(snes);CHKERRQ(ierr);
5372b4ed282SShri Abhyankar   snes->norm = vi->phinorm;
5382b4ed282SShri Abhyankar   ierr = PetscObjectGrantAccess(snes);CHKERRQ(ierr);
5392b4ed282SShri Abhyankar   SNESLogConvHistory(snes,vi->phinorm,0);
5402b4ed282SShri Abhyankar   SNESMonitor(snes,0,vi->phinorm);
5412b4ed282SShri Abhyankar 
5422b4ed282SShri Abhyankar   /* set parameter for default relative tolerance convergence test */
5432b4ed282SShri Abhyankar   snes->ttol = vi->phinorm*snes->rtol;
5442b4ed282SShri Abhyankar   /* test convergence */
5452b4ed282SShri Abhyankar   ierr = (*snes->ops->converged)(snes,0,0.0,0.0,vi->phinorm,&snes->reason,snes->cnvP);CHKERRQ(ierr);
5462b4ed282SShri Abhyankar   if (snes->reason) PetscFunctionReturn(0);
5472b4ed282SShri Abhyankar 
5482b4ed282SShri Abhyankar   for (i=0; i<maxits; i++) {
5492b4ed282SShri Abhyankar 
5502b4ed282SShri Abhyankar     /* Call general purpose update function */
5512b4ed282SShri Abhyankar     if (snes->ops->update) {
5522b4ed282SShri Abhyankar       ierr = (*snes->ops->update)(snes, snes->iter);CHKERRQ(ierr);
5532b4ed282SShri Abhyankar     }
5542b4ed282SShri Abhyankar 
5552b4ed282SShri Abhyankar     /* Solve J Y = Phi, where J is the semismooth jacobian */
556a79edbefSShri Abhyankar     /* Get the nonlinear function jacobian */
5572b4ed282SShri Abhyankar     ierr = SNESComputeJacobian(snes,X,&snes->jacobian,&snes->jacobian_pre,&flg);CHKERRQ(ierr);
558a79edbefSShri Abhyankar     /* Get the diagonal shift and row scaling vectors */
559a79edbefSShri Abhyankar     ierr = SNESVIComputeBsubdifferentialVectors(snes,X,F,snes->jacobian,vi->Da,vi->Db);CHKERRQ(ierr);
560a79edbefSShri Abhyankar     /* Compute the semismooth jacobian */
561a79edbefSShri Abhyankar     ierr = SNESVIComputeJacobian(snes->jacobian,snes->jacobian_pre,vi->Da,vi->Db);CHKERRQ(ierr);
5622b4ed282SShri Abhyankar 
5632b4ed282SShri Abhyankar     ierr = KSPSetOperators(snes->ksp,snes->jacobian,snes->jacobian_pre,flg);CHKERRQ(ierr);
5642b4ed282SShri Abhyankar     ierr = SNES_KSPSolve(snes,snes->ksp,vi->phi,Y);CHKERRQ(ierr);
5652b4ed282SShri Abhyankar     ierr = KSPGetConvergedReason(snes->ksp,&kspreason);CHKERRQ(ierr);
5663b336b49SShri Abhyankar 
5673b336b49SShri Abhyankar     if (kspreason < 0) {
5682b4ed282SShri Abhyankar       if (++snes->numLinearSolveFailures >= snes->maxLinearSolveFailures) {
5692b4ed282SShri 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);
5702b4ed282SShri Abhyankar         snes->reason = SNES_DIVERGED_LINEAR_SOLVE;
5712b4ed282SShri Abhyankar         break;
5722b4ed282SShri Abhyankar       }
5732b4ed282SShri Abhyankar     }
5742b4ed282SShri Abhyankar     ierr = KSPGetIterationNumber(snes->ksp,&lits);CHKERRQ(ierr);
5752b4ed282SShri Abhyankar     snes->linear_its += lits;
5762b4ed282SShri Abhyankar     ierr = PetscInfo2(snes,"iter=%D, linear solve iterations=%D\n",snes->iter,lits);CHKERRQ(ierr);
5772b4ed282SShri Abhyankar     /*
5782b4ed282SShri Abhyankar     if (vi->precheckstep) {
579ace3abfcSBarry Smith       PetscBool changed_y = PETSC_FALSE;
5802b4ed282SShri Abhyankar       ierr = (*vi->precheckstep)(snes,X,Y,vi->precheck,&changed_y);CHKERRQ(ierr);
5812b4ed282SShri Abhyankar     }
5822b4ed282SShri Abhyankar 
5832b4ed282SShri Abhyankar     if (PetscLogPrintInfo){
5842b4ed282SShri Abhyankar       ierr = SNESVICheckResidual_Private(snes,snes->jacobian,F,Y,G,W);CHKERRQ(ierr);
5852b4ed282SShri Abhyankar     }
5862b4ed282SShri Abhyankar     */
5872b4ed282SShri Abhyankar     /* Compute a (scaled) negative update in the line search routine:
5882b4ed282SShri Abhyankar          Y <- X - lambda*Y
5892b4ed282SShri Abhyankar        and evaluate G = function(Y) (depends on the line search).
5902b4ed282SShri Abhyankar     */
5912b4ed282SShri Abhyankar     ierr = VecCopy(Y,snes->vec_sol_update);CHKERRQ(ierr);
5922b4ed282SShri Abhyankar     ynorm = 1; gnorm = vi->phinorm;
5932b4ed282SShri Abhyankar     ierr = (*vi->LineSearch)(snes,vi->lsP,X,vi->phi,G,Y,W,vi->phinorm,xnorm,&ynorm,&gnorm,&lssucceed);CHKERRQ(ierr);
5942b4ed282SShri Abhyankar     ierr = PetscInfo4(snes,"fnorm=%18.16e, gnorm=%18.16e, ynorm=%18.16e, lssucceed=%d\n",vi->phinorm,gnorm,ynorm,(int)lssucceed);CHKERRQ(ierr);
5952b4ed282SShri Abhyankar     if (snes->reason == SNES_DIVERGED_FUNCTION_COUNT) break;
5962b4ed282SShri Abhyankar     if (snes->domainerror) {
5972b4ed282SShri Abhyankar       snes->reason = SNES_DIVERGED_FUNCTION_DOMAIN;
5982b4ed282SShri Abhyankar       PetscFunctionReturn(0);
5992b4ed282SShri Abhyankar     }
6002b4ed282SShri Abhyankar     if (!lssucceed) {
6012b4ed282SShri Abhyankar       if (++snes->numFailures >= snes->maxFailures) {
602ace3abfcSBarry Smith 	PetscBool ismin;
6032b4ed282SShri Abhyankar         snes->reason = SNES_DIVERGED_LINE_SEARCH;
6042b4ed282SShri Abhyankar         ierr = SNESVICheckLocalMin_Private(snes,snes->jacobian,G,W,gnorm,&ismin);CHKERRQ(ierr);
6052b4ed282SShri Abhyankar         if (ismin) snes->reason = SNES_DIVERGED_LOCAL_MIN;
6062b4ed282SShri Abhyankar         break;
6072b4ed282SShri Abhyankar       }
6082b4ed282SShri Abhyankar     }
6092b4ed282SShri Abhyankar     /* Update function and solution vectors */
6102b4ed282SShri Abhyankar     vi->phinorm = gnorm;
6112b4ed282SShri Abhyankar     vi->merit = 0.5*vi->phinorm*vi->phinorm;
6122b4ed282SShri Abhyankar     ierr = VecCopy(G,vi->phi);CHKERRQ(ierr);
6132b4ed282SShri Abhyankar     ierr = VecCopy(W,X);CHKERRQ(ierr);
6142b4ed282SShri Abhyankar     /* Monitor convergence */
6152b4ed282SShri Abhyankar     ierr = PetscObjectTakeAccess(snes);CHKERRQ(ierr);
6162b4ed282SShri Abhyankar     snes->iter = i+1;
6172b4ed282SShri Abhyankar     snes->norm = vi->phinorm;
6182b4ed282SShri Abhyankar     ierr = PetscObjectGrantAccess(snes);CHKERRQ(ierr);
6192b4ed282SShri Abhyankar     SNESLogConvHistory(snes,snes->norm,lits);
6202b4ed282SShri Abhyankar     SNESMonitor(snes,snes->iter,snes->norm);
6212b4ed282SShri Abhyankar     /* Test for convergence, xnorm = || X || */
6222b4ed282SShri Abhyankar     if (snes->ops->converged != SNESSkipConverged) { ierr = VecNorm(X,NORM_2,&xnorm);CHKERRQ(ierr); }
6232b4ed282SShri Abhyankar     ierr = (*snes->ops->converged)(snes,snes->iter,xnorm,ynorm,vi->phinorm,&snes->reason,snes->cnvP);CHKERRQ(ierr);
6242b4ed282SShri Abhyankar     if (snes->reason) break;
6252b4ed282SShri Abhyankar   }
6262b4ed282SShri Abhyankar   if (i == maxits) {
6272b4ed282SShri Abhyankar     ierr = PetscInfo1(snes,"Maximum number of iterations has been reached: %D\n",maxits);CHKERRQ(ierr);
6282b4ed282SShri Abhyankar     if(!snes->reason) snes->reason = SNES_DIVERGED_MAX_IT;
6292b4ed282SShri Abhyankar   }
6302b4ed282SShri Abhyankar   PetscFunctionReturn(0);
6312b4ed282SShri Abhyankar }
63269c03620SShri Abhyankar 
63369c03620SShri Abhyankar #undef __FUNCT__
63469c03620SShri Abhyankar #define __FUNCT__ "SNESVICreateIndexSets_AS"
635a79edbefSShri Abhyankar PetscErrorCode SNESVICreateIndexSets_AS(SNES snes,Vec Db,PetscReal thresh,IS* ISact,IS* ISinact)
63669c03620SShri Abhyankar {
63769c03620SShri Abhyankar   PetscErrorCode ierr;
63869c03620SShri Abhyankar   PetscInt       i,nlocal,ilow,ihigh,nloc_isact=0,nloc_isinact=0;
63969c03620SShri Abhyankar   PetscInt       *idx_act,*idx_inact,i1=0,i2=0;
64069c03620SShri Abhyankar   PetscScalar    *db;
64169c03620SShri Abhyankar 
64269c03620SShri Abhyankar   PetscFunctionBegin;
64369c03620SShri Abhyankar 
64469c03620SShri Abhyankar   ierr = VecGetLocalSize(Db,&nlocal);CHKERRQ(ierr);
64569c03620SShri Abhyankar   ierr = VecGetOwnershipRange(Db,&ilow,&ihigh);CHKERRQ(ierr);
64669c03620SShri Abhyankar   ierr = VecGetArray(Db,&db);CHKERRQ(ierr);
64769c03620SShri Abhyankar   /* Compute the sizes of the active and inactive sets */
64869c03620SShri Abhyankar   for (i=0; i < nlocal;i++) {
649fca35906SShri Abhyankar     if (PetscAbsScalar(db[i]) <= thresh) nloc_isact++;
650fca35906SShri Abhyankar     else nloc_isinact++;
65169c03620SShri Abhyankar   }
65269c03620SShri Abhyankar   ierr = PetscMalloc(nloc_isact*sizeof(PetscInt),&idx_act);CHKERRQ(ierr);
65369c03620SShri Abhyankar   ierr = PetscMalloc(nloc_isinact*sizeof(PetscInt),&idx_inact);CHKERRQ(ierr);
65469c03620SShri Abhyankar 
65569c03620SShri Abhyankar   /* Creating the indexing arrays */
656fca35906SShri Abhyankar   for(i=0; i < nlocal; i++) {
657fca35906SShri Abhyankar     if (PetscAbsScalar(db[i]) <= thresh) idx_act[i1++] = ilow+i;
658fca35906SShri Abhyankar     else idx_inact[i2++] = ilow+i;
65969c03620SShri Abhyankar   }
66069c03620SShri Abhyankar 
66169c03620SShri Abhyankar   /* Create the index sets */
66269c03620SShri Abhyankar   ierr = ISCreateGeneral(((PetscObject)snes)->comm,nloc_isact,idx_act,PETSC_COPY_VALUES,ISact);CHKERRQ(ierr);
66369c03620SShri Abhyankar   ierr = ISCreateGeneral(((PetscObject)snes)->comm,nloc_isinact,idx_inact,PETSC_COPY_VALUES,ISinact);CHKERRQ(ierr);
66469c03620SShri Abhyankar 
66569c03620SShri Abhyankar   ierr = VecRestoreArray(Db,&db);CHKERRQ(ierr);
66669c03620SShri Abhyankar   ierr = PetscFree(idx_act);CHKERRQ(ierr);
66769c03620SShri Abhyankar   ierr = PetscFree(idx_inact);CHKERRQ(ierr);
66869c03620SShri Abhyankar   PetscFunctionReturn(0);
66969c03620SShri Abhyankar }
67069c03620SShri Abhyankar 
671d950fb63SShri Abhyankar #undef __FUNCT__
672d950fb63SShri Abhyankar #define __FUNCT__ "SNESVICreateIndexSets_RS"
673d950fb63SShri Abhyankar PetscErrorCode SNESVICreateIndexSets_RS(SNES snes,Vec X,Vec Xl, Vec Xu,IS* ISact,IS* ISinact)
674d950fb63SShri Abhyankar {
675d950fb63SShri Abhyankar   PetscErrorCode ierr;
676d950fb63SShri Abhyankar   SNES_VI        *vi = (SNES_VI*)snes->data;
677d950fb63SShri Abhyankar   PetscInt       i,nlocal,ilow,ihigh,nloc_isact=0,nloc_isinact=0;
678d950fb63SShri Abhyankar   PetscInt       *idx_act,*idx_inact,i1=0,i2=0;
679d950fb63SShri Abhyankar   PetscScalar    *x,*l,*u,*f;
680d950fb63SShri Abhyankar   Vec            F = snes->vec_func;
681d950fb63SShri Abhyankar 
682d950fb63SShri Abhyankar   PetscFunctionBegin;
683d950fb63SShri Abhyankar 
684d950fb63SShri Abhyankar   ierr = VecGetLocalSize(X,&nlocal);CHKERRQ(ierr);
685d950fb63SShri Abhyankar   ierr = VecGetOwnershipRange(X,&ilow,&ihigh);CHKERRQ(ierr);
686d950fb63SShri Abhyankar   ierr = VecGetArray(X,&x);CHKERRQ(ierr);
687d950fb63SShri Abhyankar   ierr = VecGetArray(Xl,&l);CHKERRQ(ierr);
688d950fb63SShri Abhyankar   ierr = VecGetArray(Xu,&u);CHKERRQ(ierr);
689d950fb63SShri Abhyankar   ierr = VecGetArray(F,&f);CHKERRQ(ierr);
690d950fb63SShri Abhyankar   /* Compute the sizes of the active and inactive sets */
691d950fb63SShri Abhyankar   for (i=0; i < nlocal;i++) {
692d950fb63SShri Abhyankar     if (PetscAbsScalar(x[i] - l[i]) <= vi->const_tol && f[i] > vi->const_tol) nloc_isact++;
693d950fb63SShri Abhyankar     else if (PetscAbsScalar(u[i] - x[i]) <= vi->const_tol && f[i] < vi->const_tol) nloc_isact++;
694d950fb63SShri Abhyankar     else nloc_isinact++;
695d950fb63SShri Abhyankar   }
696d950fb63SShri Abhyankar   ierr = PetscMalloc(nloc_isact*sizeof(PetscInt),&idx_act);CHKERRQ(ierr);
697d950fb63SShri Abhyankar   ierr = PetscMalloc(nloc_isinact*sizeof(PetscInt),&idx_inact);CHKERRQ(ierr);
698d950fb63SShri Abhyankar 
699d950fb63SShri Abhyankar   /* Creating the indexing arrays */
700d950fb63SShri Abhyankar   for(i=0; i < nlocal; i++) {
701d950fb63SShri Abhyankar     if (PetscAbsScalar(x[i] - l[i]) <= vi->const_tol && f[i] > vi->const_tol) idx_act[i1++] = ilow+i;
702d950fb63SShri Abhyankar     else if (PetscAbsScalar(u[i] - x[i]) <= vi->const_tol && f[i] < vi->const_tol) idx_act[i1++] = ilow+i;
703d950fb63SShri Abhyankar     else idx_inact[i2++] = ilow+i;
704d950fb63SShri Abhyankar   }
705d950fb63SShri Abhyankar 
706d950fb63SShri Abhyankar   /* Create the index sets */
707d950fb63SShri Abhyankar   ierr = ISCreateGeneral(((PetscObject)snes)->comm,nloc_isact,idx_act,PETSC_COPY_VALUES,ISact);CHKERRQ(ierr);
708d950fb63SShri Abhyankar   ierr = ISCreateGeneral(((PetscObject)snes)->comm,nloc_isinact,idx_inact,PETSC_COPY_VALUES,ISinact);CHKERRQ(ierr);
709d950fb63SShri Abhyankar 
710d950fb63SShri Abhyankar   ierr = VecRestoreArray(X,&x);CHKERRQ(ierr);
711d950fb63SShri Abhyankar   ierr = VecRestoreArray(Xl,&l);CHKERRQ(ierr);
712d950fb63SShri Abhyankar   ierr = VecRestoreArray(Xu,&u);CHKERRQ(ierr);
713d950fb63SShri Abhyankar   ierr = VecRestoreArray(F,&f);CHKERRQ(ierr);
714d950fb63SShri Abhyankar   ierr = PetscFree(idx_act);CHKERRQ(ierr);
715d950fb63SShri Abhyankar   ierr = PetscFree(idx_inact);CHKERRQ(ierr);
716d950fb63SShri Abhyankar   PetscFunctionReturn(0);
717d950fb63SShri Abhyankar }
718d950fb63SShri Abhyankar 
719dbd914b8SShri Abhyankar /* Create active and inactive set vectors. The local size of this vector is set and petsc computes the global size */
720dbd914b8SShri Abhyankar #undef __FUNCT__
721dbd914b8SShri Abhyankar #define __FUNCT__ "SNESVICreateVectors_AS"
722dbd914b8SShri Abhyankar PetscErrorCode SNESVICreateVectors_AS(SNES snes,PetscInt n,Vec* newv)
723dbd914b8SShri Abhyankar {
724dbd914b8SShri Abhyankar   PetscErrorCode ierr;
725dbd914b8SShri Abhyankar   Vec            v;
726dbd914b8SShri Abhyankar 
727dbd914b8SShri Abhyankar   PetscFunctionBegin;
728dbd914b8SShri Abhyankar   ierr = VecCreate(((PetscObject)snes)->comm,&v);CHKERRQ(ierr);
729dbd914b8SShri Abhyankar   ierr = VecSetSizes(v,n,PETSC_DECIDE);CHKERRQ(ierr);
730dbd914b8SShri Abhyankar   ierr = VecSetFromOptions(v);CHKERRQ(ierr);
731dbd914b8SShri Abhyankar   *newv = v;
732dbd914b8SShri Abhyankar 
733dbd914b8SShri Abhyankar   PetscFunctionReturn(0);
734dbd914b8SShri Abhyankar }
735dbd914b8SShri Abhyankar 
736732bb160SShri Abhyankar /* Resets the snes PC and KSP when the active set sizes change */
737732bb160SShri Abhyankar #undef __FUNCT__
738732bb160SShri Abhyankar #define __FUNCT__ "SNESVIResetPCandKSP"
739732bb160SShri Abhyankar PetscErrorCode SNESVIResetPCandKSP(SNES snes,Mat Amat,Mat Pmat)
740732bb160SShri Abhyankar {
741732bb160SShri Abhyankar   PetscErrorCode ierr;
742732bb160SShri Abhyankar   KSP kspnew,snesksp;
743732bb160SShri Abhyankar   PC  pcnew;
744732bb160SShri Abhyankar   const MatSolverPackage stype;
745dbd914b8SShri Abhyankar 
746732bb160SShri Abhyankar   PetscFunctionBegin;
747732bb160SShri Abhyankar   /* The active and inactive set sizes have changed so need to create a new snes->ksp object */
748732bb160SShri Abhyankar   ierr = SNESGetKSP(snes,&snesksp);CHKERRQ(ierr);
749732bb160SShri Abhyankar   ierr = KSPCreate(((PetscObject)snes)->comm,&kspnew);CHKERRQ(ierr);
750732bb160SShri Abhyankar   /* Copy over snes->ksp info */
751732bb160SShri Abhyankar   kspnew->pc_side = snesksp->pc_side;
752732bb160SShri Abhyankar   kspnew->rtol    = snesksp->rtol;
753732bb160SShri Abhyankar   kspnew->abstol    = snesksp->abstol;
754732bb160SShri Abhyankar   kspnew->max_it  = snesksp->max_it;
755732bb160SShri Abhyankar   ierr = KSPSetType(kspnew,((PetscObject)snesksp)->type_name);CHKERRQ(ierr);
756732bb160SShri Abhyankar   ierr = KSPGetPC(kspnew,&pcnew);CHKERRQ(ierr);
757732bb160SShri Abhyankar   ierr = PCSetType(kspnew->pc,((PetscObject)snesksp->pc)->type_name);CHKERRQ(ierr);
758732bb160SShri Abhyankar   ierr = PCSetOperators(kspnew->pc,Amat,Pmat,DIFFERENT_NONZERO_PATTERN);CHKERRQ(ierr);
759732bb160SShri Abhyankar   ierr = PCFactorGetMatSolverPackage(snesksp->pc,&stype);CHKERRQ(ierr);
760732bb160SShri Abhyankar   ierr = PCFactorSetMatSolverPackage(kspnew->pc,stype);CHKERRQ(ierr);
761732bb160SShri Abhyankar   ierr = KSPDestroy(snesksp);CHKERRQ(ierr);
762732bb160SShri Abhyankar   snes->ksp = kspnew;
763732bb160SShri Abhyankar   ierr = PetscLogObjectParent(snes,kspnew);CHKERRQ(ierr);
764732bb160SShri Abhyankar   ierr = KSPSetFromOptions(kspnew);CHKERRQ(ierr);
765732bb160SShri Abhyankar   PetscFunctionReturn(0);
766732bb160SShri Abhyankar }
76769c03620SShri Abhyankar /* Variational Inequality solver using active set method */
76869c03620SShri Abhyankar #undef __FUNCT__
76969c03620SShri Abhyankar #define __FUNCT__ "SNESSolveVI_AS"
77069c03620SShri Abhyankar PetscErrorCode SNESSolveVI_AS(SNES snes)
77169c03620SShri Abhyankar {
77269c03620SShri Abhyankar   SNES_VI          *vi = (SNES_VI*)snes->data;
77369c03620SShri Abhyankar   PetscErrorCode     ierr;
774408da460SShri Abhyankar   PetscInt           maxits,i,lits,Nis_act=0;
7753b336b49SShri Abhyankar   PetscBool         lssucceed;
77669c03620SShri Abhyankar   MatStructure       flg = DIFFERENT_NONZERO_PATTERN;
77769c03620SShri Abhyankar   PetscReal          gnorm,xnorm=0,ynorm;
77869c03620SShri Abhyankar   Vec                Y,X,F,G,W;
77969c03620SShri Abhyankar   KSPConvergedReason kspreason;
78069c03620SShri Abhyankar 
78169c03620SShri Abhyankar   PetscFunctionBegin;
78269c03620SShri Abhyankar   snes->numFailures            = 0;
78369c03620SShri Abhyankar   snes->numLinearSolveFailures = 0;
78469c03620SShri Abhyankar   snes->reason                 = SNES_CONVERGED_ITERATING;
78569c03620SShri Abhyankar 
78669c03620SShri Abhyankar   maxits	= snes->max_its;	/* maximum number of iterations */
78769c03620SShri Abhyankar   X		= snes->vec_sol;	/* solution vector */
78869c03620SShri Abhyankar   F		= snes->vec_func;	/* residual vector */
78969c03620SShri Abhyankar   Y		= snes->work[0];	/* work vectors */
79069c03620SShri Abhyankar   G		= snes->work[1];
79169c03620SShri Abhyankar   W		= snes->work[2];
79269c03620SShri Abhyankar 
79369c03620SShri Abhyankar   ierr = PetscObjectTakeAccess(snes);CHKERRQ(ierr);
79469c03620SShri Abhyankar   snes->iter = 0;
79569c03620SShri Abhyankar   snes->norm = 0.0;
79669c03620SShri Abhyankar   ierr = PetscObjectGrantAccess(snes);CHKERRQ(ierr);
79769c03620SShri Abhyankar 
79869c03620SShri Abhyankar   ierr = SNESVIAdjustInitialGuess(X,vi->xl,vi->xu);CHKERRQ(ierr);
79969c03620SShri Abhyankar   ierr = SNESComputeFunction(snes,X,vi->phi);CHKERRQ(ierr);
80069c03620SShri Abhyankar   if (snes->domainerror) {
80169c03620SShri Abhyankar     snes->reason = SNES_DIVERGED_FUNCTION_DOMAIN;
80269c03620SShri Abhyankar     PetscFunctionReturn(0);
80369c03620SShri Abhyankar   }
80469c03620SShri Abhyankar    /* Compute Merit function */
80569c03620SShri Abhyankar   ierr = SNESVIComputeMeritFunction(vi->phi,&vi->merit,&vi->phinorm);CHKERRQ(ierr);
80669c03620SShri Abhyankar 
80769c03620SShri Abhyankar   ierr = VecNormBegin(X,NORM_2,&xnorm);CHKERRQ(ierr);	/* xnorm <- ||x||  */
80869c03620SShri Abhyankar   ierr = VecNormEnd(X,NORM_2,&xnorm);CHKERRQ(ierr);
80969c03620SShri Abhyankar   if PetscIsInfOrNanReal(vi->merit) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FP,"User provided compute function generated a Not-a-Number");
81069c03620SShri Abhyankar 
81169c03620SShri Abhyankar   ierr = PetscObjectTakeAccess(snes);CHKERRQ(ierr);
81269c03620SShri Abhyankar   snes->norm = vi->phinorm;
81369c03620SShri Abhyankar   ierr = PetscObjectGrantAccess(snes);CHKERRQ(ierr);
81469c03620SShri Abhyankar   SNESLogConvHistory(snes,vi->phinorm,0);
81569c03620SShri Abhyankar   SNESMonitor(snes,0,vi->phinorm);
81669c03620SShri Abhyankar 
81769c03620SShri Abhyankar   /* set parameter for default relative tolerance convergence test */
81869c03620SShri Abhyankar   snes->ttol = vi->phinorm*snes->rtol;
81969c03620SShri Abhyankar   /* test convergence */
82069c03620SShri Abhyankar   ierr = (*snes->ops->converged)(snes,0,0.0,0.0,vi->phinorm,&snes->reason,snes->cnvP);CHKERRQ(ierr);
82169c03620SShri Abhyankar   if (snes->reason) PetscFunctionReturn(0);
82269c03620SShri Abhyankar 
82369c03620SShri Abhyankar   for (i=0; i<maxits; i++) {
82469c03620SShri Abhyankar 
825a79edbefSShri Abhyankar     IS                 IS_act,IS_inact; /* _act -> active set _inact -> inactive set */
826a79edbefSShri Abhyankar     PetscReal          thresh,J_norm1;
827dbd914b8SShri Abhyankar     VecScatter         scat_act,scat_inact;
828408da460SShri Abhyankar     PetscInt           nis_act,nis_inact,Nis_act_prev;
829dbd914b8SShri Abhyankar     Vec                Da_act,Da_inact,Db_inact;
830dbd914b8SShri Abhyankar     Vec                Y_act,Y_inact,phi_act,phi_inact;
831d76c674bSShri Abhyankar     Mat                jac_inact_inact,jac_inact_act,prejac_inact_inact;
832a79edbefSShri Abhyankar 
83369c03620SShri Abhyankar     /* Call general purpose update function */
83469c03620SShri Abhyankar     if (snes->ops->update) {
83569c03620SShri Abhyankar       ierr = (*snes->ops->update)(snes, snes->iter);CHKERRQ(ierr);
83669c03620SShri Abhyankar     }
83769c03620SShri Abhyankar     ierr = SNESComputeJacobian(snes,X,&snes->jacobian,&snes->jacobian_pre,&flg);CHKERRQ(ierr);
83869c03620SShri Abhyankar     /* Compute the threshold value for creating active and inactive sets */
83969c03620SShri Abhyankar     ierr = MatNorm(snes->jacobian,NORM_1,&J_norm1);CHKERRQ(ierr);
84069c03620SShri Abhyankar     thresh = PetscMin(vi->merit,1e-2)/(1+J_norm1);
841a79edbefSShri Abhyankar 
842a79edbefSShri Abhyankar     /* Compute B-subdifferential vectors Da and Db */
843a79edbefSShri Abhyankar     ierr = SNESVIComputeBsubdifferentialVectors(snes,X,F,snes->jacobian,vi->Da,vi->Db);CHKERRQ(ierr);
844dbd914b8SShri Abhyankar 
84569c03620SShri Abhyankar     /* Create active and inactive index sets */
84669c03620SShri Abhyankar     ierr = SNESVICreateIndexSets_AS(snes,vi->Db,thresh,&IS_act,&IS_inact);CHKERRQ(ierr);
84769c03620SShri Abhyankar 
848408da460SShri Abhyankar     Nis_act_prev = Nis_act;
849408da460SShri Abhyankar     /* Get sizes of active and inactive sets */
850dbd914b8SShri Abhyankar     ierr = ISGetLocalSize(IS_act,&nis_act);CHKERRQ(ierr);
851dbd914b8SShri Abhyankar     ierr = ISGetLocalSize(IS_inact,&nis_inact);CHKERRQ(ierr);
852408da460SShri Abhyankar     ierr = ISGetSize(IS_act,&Nis_act);CHKERRQ(ierr);
853dbd914b8SShri Abhyankar 
854d76c674bSShri Abhyankar     ierr = PetscPrintf(PETSC_COMM_WORLD,"Size of active set = %d, size of inactive set = %d\n",nis_act,nis_inact);CHKERRQ(ierr);
855d76c674bSShri Abhyankar 
856dbd914b8SShri Abhyankar     /* Create active and inactive set vectors */
857dbd914b8SShri Abhyankar     ierr = SNESVICreateVectors_AS(snes,nis_act,&Da_act);CHKERRQ(ierr);
858dbd914b8SShri Abhyankar     ierr = SNESVICreateVectors_AS(snes,nis_inact,&Da_inact);CHKERRQ(ierr);
859dbd914b8SShri Abhyankar     ierr = SNESVICreateVectors_AS(snes,nis_inact,&Db_inact);CHKERRQ(ierr);
860dbd914b8SShri Abhyankar     ierr = SNESVICreateVectors_AS(snes,nis_act,&phi_act);CHKERRQ(ierr);
861dbd914b8SShri Abhyankar     ierr = SNESVICreateVectors_AS(snes,nis_inact,&phi_inact);CHKERRQ(ierr);
862dbd914b8SShri Abhyankar     ierr = SNESVICreateVectors_AS(snes,nis_act,&Y_act);CHKERRQ(ierr);
863dbd914b8SShri Abhyankar     ierr = SNESVICreateVectors_AS(snes,nis_inact,&Y_inact);CHKERRQ(ierr);
864dbd914b8SShri Abhyankar 
865dbd914b8SShri Abhyankar     /* Create inactive set submatrices */
866dbd914b8SShri Abhyankar     ierr = MatGetSubMatrix(snes->jacobian,IS_inact,IS_act,MAT_INITIAL_MATRIX,&jac_inact_act);CHKERRQ(ierr);
867dbd914b8SShri Abhyankar     ierr = MatGetSubMatrix(snes->jacobian,IS_inact,IS_inact,MAT_INITIAL_MATRIX,&jac_inact_inact);CHKERRQ(ierr);
868dbd914b8SShri Abhyankar 
869dbd914b8SShri Abhyankar     /* Create scatter contexts */
870dbd914b8SShri Abhyankar     ierr = VecScatterCreate(vi->Da,IS_act,Da_act,PETSC_NULL,&scat_act);CHKERRQ(ierr);
871dbd914b8SShri Abhyankar     ierr = VecScatterCreate(vi->Da,IS_inact,Da_inact,PETSC_NULL,&scat_inact);CHKERRQ(ierr);
872dbd914b8SShri Abhyankar 
873dbd914b8SShri Abhyankar     /* Do a vec scatter to active and inactive set vectors */
874dbd914b8SShri Abhyankar     ierr = VecScatterBegin(scat_act,vi->Da,Da_act,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
875dbd914b8SShri Abhyankar     ierr = VecScatterEnd(scat_act,vi->Da,Da_act,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
876dbd914b8SShri Abhyankar 
877dbd914b8SShri Abhyankar     ierr = VecScatterBegin(scat_inact,vi->Da,Da_inact,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
878dbd914b8SShri Abhyankar     ierr = VecScatterEnd(scat_inact,vi->Da,Da_inact,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
879dbd914b8SShri Abhyankar 
880dbd914b8SShri Abhyankar     ierr = VecScatterBegin(scat_inact,vi->Db,Db_inact,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
881dbd914b8SShri Abhyankar     ierr = VecScatterEnd(scat_inact,vi->Db,Db_inact,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
882dbd914b8SShri Abhyankar 
883dbd914b8SShri Abhyankar     ierr = VecScatterBegin(scat_act,vi->phi,phi_act,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
884dbd914b8SShri Abhyankar     ierr = VecScatterEnd(scat_act,vi->phi,phi_act,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
885dbd914b8SShri Abhyankar 
886dbd914b8SShri Abhyankar     ierr = VecScatterBegin(scat_inact,vi->phi,phi_inact,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
887dbd914b8SShri Abhyankar     ierr = VecScatterEnd(scat_inact,vi->phi,phi_inact,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
888dbd914b8SShri Abhyankar 
889dbd914b8SShri Abhyankar     ierr = VecScatterBegin(scat_act,Y,Y_act,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
890dbd914b8SShri Abhyankar     ierr = VecScatterEnd(scat_act,Y,Y_act,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
891dbd914b8SShri Abhyankar 
892dbd914b8SShri Abhyankar     ierr = VecScatterBegin(scat_inact,Y,Y_inact,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
893dbd914b8SShri Abhyankar     ierr = VecScatterEnd(scat_inact,Y,Y_inact,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
894dbd914b8SShri Abhyankar 
895dbd914b8SShri Abhyankar     /* Active set direction */
896dbd914b8SShri Abhyankar     ierr = VecPointwiseDivide(Y_act,phi_act,Da_act);CHKERRQ(ierr);
897d76c674bSShri Abhyankar     /* inactive set jacobian and preconditioner */
898dbd914b8SShri Abhyankar     ierr = VecPointwiseDivide(Da_inact,Da_inact,Db_inact);CHKERRQ(ierr);
899dbd914b8SShri Abhyankar     ierr = MatDiagonalSet(jac_inact_inact,Da_inact,ADD_VALUES);CHKERRQ(ierr);
900d76c674bSShri Abhyankar     if (snes->jacobian != snes->jacobian_pre) {
901d76c674bSShri Abhyankar       ierr = MatGetSubMatrix(snes->jacobian_pre,IS_inact,IS_inact,MAT_INITIAL_MATRIX,&prejac_inact_inact);CHKERRQ(ierr);
902d76c674bSShri Abhyankar       ierr = MatDiagonalSet(prejac_inact_inact,Da_inact,ADD_VALUES);CHKERRQ(ierr);
903d76c674bSShri Abhyankar     } else prejac_inact_inact = jac_inact_inact;
904d76c674bSShri Abhyankar 
905dbd914b8SShri Abhyankar     /* right hand side */
906dbd914b8SShri Abhyankar     ierr = VecPointwiseDivide(phi_inact,phi_inact,Db_inact);CHKERRQ(ierr);
907dbd914b8SShri Abhyankar     ierr = MatMult(jac_inact_act,Y_act,Db_inact);CHKERRQ(ierr);
908dbd914b8SShri Abhyankar     ierr = VecAXPY(phi_inact,-1.0,Db_inact);CHKERRQ(ierr);
909dbd914b8SShri Abhyankar 
910408da460SShri Abhyankar     if ((i != 0) && (Nis_act != Nis_act_prev)) {
911732bb160SShri Abhyankar       ierr = SNESVIResetPCandKSP(snes,jac_inact_inact,prejac_inact_inact);CHKERRQ(ierr);
912408da460SShri Abhyankar     }
913408da460SShri Abhyankar 
914d76c674bSShri Abhyankar     ierr = KSPSetOperators(snes->ksp,jac_inact_inact,prejac_inact_inact,flg);CHKERRQ(ierr);
915dbd914b8SShri Abhyankar     ierr = SNES_KSPSolve(snes,snes->ksp,phi_inact,Y_inact);CHKERRQ(ierr);
916dbd914b8SShri Abhyankar     ierr = KSPGetConvergedReason(snes->ksp,&kspreason);CHKERRQ(ierr);
9173b336b49SShri Abhyankar     if (kspreason < 0) {
9183b336b49SShri Abhyankar       if (++snes->numLinearSolveFailures >= snes->maxLinearSolveFailures) {
9193b336b49SShri 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);
9203b336b49SShri Abhyankar         snes->reason = SNES_DIVERGED_LINEAR_SOLVE;
9213b336b49SShri Abhyankar         break;
9223b336b49SShri Abhyankar       }
9233b336b49SShri Abhyankar      }
924dbd914b8SShri Abhyankar 
925dbd914b8SShri Abhyankar     ierr = VecScatterBegin(scat_act,Y_act,Y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
926dbd914b8SShri Abhyankar     ierr = VecScatterEnd(scat_act,Y_act,Y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
927dbd914b8SShri Abhyankar     ierr = VecScatterBegin(scat_inact,Y_inact,Y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
928dbd914b8SShri Abhyankar     ierr = VecScatterEnd(scat_inact,Y_inact,Y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
929dbd914b8SShri Abhyankar 
930dbd914b8SShri Abhyankar     ierr = VecDestroy(Da_act);CHKERRQ(ierr);
931dbd914b8SShri Abhyankar     ierr = VecDestroy(Da_inact);CHKERRQ(ierr);
932dbd914b8SShri Abhyankar     ierr = VecDestroy(Db_inact);CHKERRQ(ierr);
933dbd914b8SShri Abhyankar     ierr = VecDestroy(phi_act);CHKERRQ(ierr);
934dbd914b8SShri Abhyankar     ierr = VecDestroy(phi_inact);CHKERRQ(ierr);
935dbd914b8SShri Abhyankar     ierr = VecDestroy(Y_act);CHKERRQ(ierr);
936dbd914b8SShri Abhyankar     ierr = VecDestroy(Y_inact);CHKERRQ(ierr);
937dbd914b8SShri Abhyankar     ierr = VecScatterDestroy(scat_act);CHKERRQ(ierr);
938dbd914b8SShri Abhyankar     ierr = VecScatterDestroy(scat_inact);CHKERRQ(ierr);
939730c24dcSShri Abhyankar     ierr = ISDestroy(IS_act);CHKERRQ(ierr);
940730c24dcSShri Abhyankar     ierr = ISDestroy(IS_inact);CHKERRQ(ierr);
941bac2f86eSShri Abhyankar     ierr = MatDestroy(jac_inact_act);CHKERRQ(ierr);
942bac2f86eSShri Abhyankar     ierr = MatDestroy(jac_inact_inact);CHKERRQ(ierr);
943d76c674bSShri Abhyankar     if (snes->jacobian != snes->jacobian_pre) {
944d76c674bSShri Abhyankar       ierr = MatDestroy(prejac_inact_inact);CHKERRQ(ierr);
945d76c674bSShri Abhyankar     }
946730c24dcSShri Abhyankar 
94769c03620SShri Abhyankar     ierr = KSPGetIterationNumber(snes->ksp,&lits);CHKERRQ(ierr);
94869c03620SShri Abhyankar     snes->linear_its += lits;
94969c03620SShri Abhyankar     ierr = PetscInfo2(snes,"iter=%D, linear solve iterations=%D\n",snes->iter,lits);CHKERRQ(ierr);
95069c03620SShri Abhyankar     /*
95169c03620SShri Abhyankar     if (vi->precheckstep) {
95269c03620SShri Abhyankar       PetscBool changed_y = PETSC_FALSE;
95369c03620SShri Abhyankar       ierr = (*vi->precheckstep)(snes,X,Y,vi->precheck,&changed_y);CHKERRQ(ierr);
95469c03620SShri Abhyankar     }
95569c03620SShri Abhyankar 
95669c03620SShri Abhyankar     if (PetscLogPrintInfo){
95769c03620SShri Abhyankar       ierr = SNESVICheckResidual_Private(snes,snes->jacobian,F,Y,G,W);CHKERRQ(ierr);
95869c03620SShri Abhyankar     }
95969c03620SShri Abhyankar     */
96069c03620SShri Abhyankar     /* Compute a (scaled) negative update in the line search routine:
96169c03620SShri Abhyankar          Y <- X - lambda*Y
96269c03620SShri Abhyankar        and evaluate G = function(Y) (depends on the line search).
96369c03620SShri Abhyankar     */
96469c03620SShri Abhyankar     ierr = VecCopy(Y,snes->vec_sol_update);CHKERRQ(ierr);
96569c03620SShri Abhyankar     ynorm = 1; gnorm = vi->phinorm;
9663b336b49SShri Abhyankar     ierr = SNESVIComputeJacobian(snes->jacobian,snes->jacobian_pre,vi->Da,vi->Db);CHKERRQ(ierr);
96769c03620SShri Abhyankar     ierr = (*vi->LineSearch)(snes,vi->lsP,X,vi->phi,G,Y,W,vi->phinorm,xnorm,&ynorm,&gnorm,&lssucceed);CHKERRQ(ierr);
96869c03620SShri Abhyankar     ierr = PetscInfo4(snes,"fnorm=%18.16e, gnorm=%18.16e, ynorm=%18.16e, lssucceed=%d\n",vi->phinorm,gnorm,ynorm,(int)lssucceed);CHKERRQ(ierr);
96969c03620SShri Abhyankar     if (snes->reason == SNES_DIVERGED_FUNCTION_COUNT) break;
97069c03620SShri Abhyankar     if (snes->domainerror) {
97169c03620SShri Abhyankar       snes->reason = SNES_DIVERGED_FUNCTION_DOMAIN;
97269c03620SShri Abhyankar       PetscFunctionReturn(0);
97369c03620SShri Abhyankar     }
97469c03620SShri Abhyankar     if (!lssucceed) {
97569c03620SShri Abhyankar       if (++snes->numFailures >= snes->maxFailures) {
97669c03620SShri Abhyankar 	PetscBool ismin;
97769c03620SShri Abhyankar         snes->reason = SNES_DIVERGED_LINE_SEARCH;
97869c03620SShri Abhyankar         ierr = SNESVICheckLocalMin_Private(snes,snes->jacobian,G,W,gnorm,&ismin);CHKERRQ(ierr);
97969c03620SShri Abhyankar         if (ismin) snes->reason = SNES_DIVERGED_LOCAL_MIN;
98069c03620SShri Abhyankar         break;
98169c03620SShri Abhyankar       }
98269c03620SShri Abhyankar     }
98369c03620SShri Abhyankar     /* Update function and solution vectors */
98469c03620SShri Abhyankar     vi->phinorm = gnorm;
98569c03620SShri Abhyankar     vi->merit = 0.5*vi->phinorm*vi->phinorm;
98669c03620SShri Abhyankar     ierr = VecCopy(G,vi->phi);CHKERRQ(ierr);
98769c03620SShri Abhyankar     ierr = VecCopy(W,X);CHKERRQ(ierr);
98869c03620SShri Abhyankar     /* Monitor convergence */
98969c03620SShri Abhyankar     ierr = PetscObjectTakeAccess(snes);CHKERRQ(ierr);
99069c03620SShri Abhyankar     snes->iter = i+1;
99169c03620SShri Abhyankar     snes->norm = vi->phinorm;
99269c03620SShri Abhyankar     ierr = PetscObjectGrantAccess(snes);CHKERRQ(ierr);
99369c03620SShri Abhyankar     SNESLogConvHistory(snes,snes->norm,lits);
99469c03620SShri Abhyankar     SNESMonitor(snes,snes->iter,snes->norm);
99569c03620SShri Abhyankar     /* Test for convergence, xnorm = || X || */
99669c03620SShri Abhyankar     if (snes->ops->converged != SNESSkipConverged) { ierr = VecNorm(X,NORM_2,&xnorm);CHKERRQ(ierr); }
99769c03620SShri Abhyankar     ierr = (*snes->ops->converged)(snes,snes->iter,xnorm,ynorm,vi->phinorm,&snes->reason,snes->cnvP);CHKERRQ(ierr);
99869c03620SShri Abhyankar     if (snes->reason) break;
99969c03620SShri Abhyankar   }
100069c03620SShri Abhyankar   if (i == maxits) {
100169c03620SShri Abhyankar     ierr = PetscInfo1(snes,"Maximum number of iterations has been reached: %D\n",maxits);CHKERRQ(ierr);
100269c03620SShri Abhyankar     if(!snes->reason) snes->reason = SNES_DIVERGED_MAX_IT;
100369c03620SShri Abhyankar   }
100469c03620SShri Abhyankar   PetscFunctionReturn(0);
100569c03620SShri Abhyankar }
100669c03620SShri Abhyankar 
1007d950fb63SShri Abhyankar /* Variational Inequality solver using active set method */
1008d950fb63SShri Abhyankar #undef __FUNCT__
1009d950fb63SShri Abhyankar #define __FUNCT__ "SNESSolveVI_RS"
1010d950fb63SShri Abhyankar PetscErrorCode SNESSolveVI_RS(SNES snes)
1011d950fb63SShri Abhyankar {
1012d950fb63SShri Abhyankar   SNES_VI          *vi = (SNES_VI*)snes->data;
1013d950fb63SShri Abhyankar   PetscErrorCode     ierr;
1014d950fb63SShri Abhyankar   PetscInt           maxits,i,lits,Nis_act=0;
1015d950fb63SShri Abhyankar   PetscBool         lssucceed;
1016d950fb63SShri Abhyankar   MatStructure       flg = DIFFERENT_NONZERO_PATTERN;
1017d950fb63SShri Abhyankar   PetscReal          gnorm,xnorm=0,ynorm;
1018d950fb63SShri Abhyankar   Vec                Y,X,F,G,W;
1019d950fb63SShri Abhyankar   KSPConvergedReason kspreason;
1020d950fb63SShri Abhyankar 
1021d950fb63SShri Abhyankar   PetscFunctionBegin;
1022d950fb63SShri Abhyankar   snes->numFailures            = 0;
1023d950fb63SShri Abhyankar   snes->numLinearSolveFailures = 0;
1024d950fb63SShri Abhyankar   snes->reason                 = SNES_CONVERGED_ITERATING;
1025d950fb63SShri Abhyankar 
1026d950fb63SShri Abhyankar   maxits	= snes->max_its;	/* maximum number of iterations */
1027d950fb63SShri Abhyankar   X		= snes->vec_sol;	/* solution vector */
1028d950fb63SShri Abhyankar   F		= snes->vec_func;	/* residual vector */
1029d950fb63SShri Abhyankar   Y		= snes->work[0];	/* work vectors */
1030d950fb63SShri Abhyankar   G		= snes->work[1];
1031d950fb63SShri Abhyankar   W		= snes->work[2];
1032d950fb63SShri Abhyankar 
1033d950fb63SShri Abhyankar   ierr = PetscObjectTakeAccess(snes);CHKERRQ(ierr);
1034d950fb63SShri Abhyankar   snes->iter = 0;
1035d950fb63SShri Abhyankar   snes->norm = 0.0;
1036d950fb63SShri Abhyankar   ierr = PetscObjectGrantAccess(snes);CHKERRQ(ierr);
1037d950fb63SShri Abhyankar 
1038d950fb63SShri Abhyankar   ierr = SNESVIAdjustInitialGuess(X,vi->xl,vi->xu);CHKERRQ(ierr);
1039d950fb63SShri Abhyankar   ierr = SNESComputeFunction(snes,X,vi->phi);CHKERRQ(ierr);
1040d950fb63SShri Abhyankar   if (snes->domainerror) {
1041d950fb63SShri Abhyankar     snes->reason = SNES_DIVERGED_FUNCTION_DOMAIN;
1042d950fb63SShri Abhyankar     PetscFunctionReturn(0);
1043d950fb63SShri Abhyankar   }
1044d950fb63SShri Abhyankar    /* Compute Merit function */
1045d950fb63SShri Abhyankar   ierr = SNESVIComputeMeritFunction(vi->phi,&vi->merit,&vi->phinorm);CHKERRQ(ierr);
1046d950fb63SShri Abhyankar 
1047d950fb63SShri Abhyankar   ierr = VecNormBegin(X,NORM_2,&xnorm);CHKERRQ(ierr);	/* xnorm <- ||x||  */
1048d950fb63SShri Abhyankar   ierr = VecNormEnd(X,NORM_2,&xnorm);CHKERRQ(ierr);
1049d950fb63SShri Abhyankar   if PetscIsInfOrNanReal(vi->merit) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FP,"User provided compute function generated a Not-a-Number");
1050d950fb63SShri Abhyankar 
1051d950fb63SShri Abhyankar   ierr = PetscObjectTakeAccess(snes);CHKERRQ(ierr);
1052d950fb63SShri Abhyankar   snes->norm = vi->phinorm;
1053d950fb63SShri Abhyankar   ierr = PetscObjectGrantAccess(snes);CHKERRQ(ierr);
1054d950fb63SShri Abhyankar   SNESLogConvHistory(snes,vi->phinorm,0);
1055d950fb63SShri Abhyankar   SNESMonitor(snes,0,vi->phinorm);
1056d950fb63SShri Abhyankar 
1057d950fb63SShri Abhyankar   /* set parameter for default relative tolerance convergence test */
1058d950fb63SShri Abhyankar   snes->ttol = vi->phinorm*snes->rtol;
1059d950fb63SShri Abhyankar   /* test convergence */
1060d950fb63SShri Abhyankar   ierr = (*snes->ops->converged)(snes,0,0.0,0.0,vi->phinorm,&snes->reason,snes->cnvP);CHKERRQ(ierr);
1061d950fb63SShri Abhyankar   if (snes->reason) PetscFunctionReturn(0);
1062d950fb63SShri Abhyankar 
1063d950fb63SShri Abhyankar   for (i=0; i<maxits; i++) {
1064d950fb63SShri Abhyankar 
1065d950fb63SShri Abhyankar     IS                 IS_act,IS_inact; /* _act -> active set _inact -> inactive set */
1066d950fb63SShri Abhyankar     VecScatter         scat_act,scat_inact;
1067d950fb63SShri Abhyankar     PetscInt           nis_act,nis_inact,Nis_act_prev;
1068d950fb63SShri Abhyankar     Vec                Y_act,Y_inact,phi_inact;
1069d950fb63SShri Abhyankar     Mat                jac_inact_inact,prejac_inact_inact;
1070d950fb63SShri Abhyankar 
1071d950fb63SShri Abhyankar     /* Call general purpose update function */
1072d950fb63SShri Abhyankar     if (snes->ops->update) {
1073d950fb63SShri Abhyankar       ierr = (*snes->ops->update)(snes, snes->iter);CHKERRQ(ierr);
1074d950fb63SShri Abhyankar     }
1075d950fb63SShri Abhyankar     ierr = SNESComputeJacobian(snes,X,&snes->jacobian,&snes->jacobian_pre,&flg);CHKERRQ(ierr);
1076d950fb63SShri Abhyankar     ierr = SNESVIComputeBsubdifferentialVectors(snes,X,F,snes->jacobian,vi->Da,vi->Db);CHKERRQ(ierr);
1077d950fb63SShri Abhyankar     ierr = SNESVIComputeJacobian(snes->jacobian,snes->jacobian_pre,vi->Da,vi->Db);CHKERRQ(ierr);
1078d950fb63SShri Abhyankar     /* Create active and inactive index sets */
1079d950fb63SShri Abhyankar     ierr = SNESVICreateIndexSets_RS(snes,X,vi->xl,vi->xu,&IS_act,&IS_inact);CHKERRQ(ierr);
1080d950fb63SShri Abhyankar 
1081d950fb63SShri Abhyankar     Nis_act_prev = Nis_act;
1082d950fb63SShri Abhyankar     /* Get sizes of active and inactive sets */
1083d950fb63SShri Abhyankar     ierr = ISGetLocalSize(IS_act,&nis_act);CHKERRQ(ierr);
1084d950fb63SShri Abhyankar     ierr = ISGetLocalSize(IS_inact,&nis_inact);CHKERRQ(ierr);
1085d950fb63SShri Abhyankar     ierr = ISGetSize(IS_act,&Nis_act);CHKERRQ(ierr);
1086d950fb63SShri Abhyankar 
1087d950fb63SShri Abhyankar     ierr = PetscPrintf(PETSC_COMM_WORLD,"Size of active set = %d, size of inactive set = %d\n",nis_act,nis_inact);CHKERRQ(ierr);
1088d950fb63SShri Abhyankar 
1089d950fb63SShri Abhyankar     /* Create active and inactive set vectors */
1090d950fb63SShri Abhyankar     ierr = SNESVICreateVectors_AS(snes,nis_inact,&phi_inact);CHKERRQ(ierr);
1091d950fb63SShri Abhyankar     ierr = SNESVICreateVectors_AS(snes,nis_act,&Y_act);CHKERRQ(ierr);
1092d950fb63SShri Abhyankar     ierr = SNESVICreateVectors_AS(snes,nis_inact,&Y_inact);CHKERRQ(ierr);
1093d950fb63SShri Abhyankar 
1094d950fb63SShri Abhyankar     /* Create inactive set submatrices */
1095d950fb63SShri Abhyankar     ierr = MatGetSubMatrix(snes->jacobian,IS_inact,IS_inact,MAT_INITIAL_MATRIX,&jac_inact_inact);CHKERRQ(ierr);
1096d950fb63SShri Abhyankar 
1097d950fb63SShri Abhyankar     /* Create scatter contexts */
1098d950fb63SShri Abhyankar     ierr = VecScatterCreate(Y,IS_act,Y_act,PETSC_NULL,&scat_act);CHKERRQ(ierr);
1099d950fb63SShri Abhyankar     ierr = VecScatterCreate(Y,IS_inact,Y_inact,PETSC_NULL,&scat_inact);CHKERRQ(ierr);
1100d950fb63SShri Abhyankar 
1101d950fb63SShri Abhyankar     /* Do a vec scatter to active and inactive set vectors */
1102d950fb63SShri Abhyankar     ierr = VecScatterBegin(scat_inact,vi->phi,phi_inact,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1103d950fb63SShri Abhyankar     ierr = VecScatterEnd(scat_inact,vi->phi,phi_inact,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1104d950fb63SShri Abhyankar 
1105d950fb63SShri Abhyankar     ierr = VecScatterBegin(scat_act,Y,Y_act,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1106d950fb63SShri Abhyankar     ierr = VecScatterEnd(scat_act,Y,Y_act,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1107d950fb63SShri Abhyankar 
1108d950fb63SShri Abhyankar     ierr = VecScatterBegin(scat_inact,Y,Y_inact,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1109d950fb63SShri Abhyankar     ierr = VecScatterEnd(scat_inact,Y,Y_inact,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1110d950fb63SShri Abhyankar 
1111d950fb63SShri Abhyankar     /* Active set direction = 0*/
1112d950fb63SShri Abhyankar     ierr = VecSet(Y_act,0);CHKERRQ(ierr);
1113d950fb63SShri Abhyankar     if (snes->jacobian != snes->jacobian_pre) {
1114d950fb63SShri Abhyankar       ierr = MatGetSubMatrix(snes->jacobian_pre,IS_inact,IS_inact,MAT_INITIAL_MATRIX,&prejac_inact_inact);CHKERRQ(ierr);
1115d950fb63SShri Abhyankar     } else prejac_inact_inact = jac_inact_inact;
1116d950fb63SShri Abhyankar 
1117d950fb63SShri Abhyankar     if ((i != 0) && (Nis_act != Nis_act_prev)) {
1118732bb160SShri Abhyankar       ierr = SNESVIResetPCandKSP(snes,jac_inact_inact,prejac_inact_inact);CHKERRQ(ierr);
1119d950fb63SShri Abhyankar     }
1120d950fb63SShri Abhyankar 
1121d950fb63SShri Abhyankar     ierr = KSPSetOperators(snes->ksp,jac_inact_inact,prejac_inact_inact,flg);CHKERRQ(ierr);
1122d950fb63SShri Abhyankar     ierr = SNES_KSPSolve(snes,snes->ksp,phi_inact,Y_inact);CHKERRQ(ierr);
1123d950fb63SShri Abhyankar     ierr = KSPGetConvergedReason(snes->ksp,&kspreason);CHKERRQ(ierr);
1124d950fb63SShri Abhyankar     if (kspreason < 0) {
1125d950fb63SShri Abhyankar       if (++snes->numLinearSolveFailures >= snes->maxLinearSolveFailures) {
1126d950fb63SShri 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);
1127d950fb63SShri Abhyankar         snes->reason = SNES_DIVERGED_LINEAR_SOLVE;
1128d950fb63SShri Abhyankar         break;
1129d950fb63SShri Abhyankar       }
1130d950fb63SShri Abhyankar      }
1131d950fb63SShri Abhyankar 
1132d950fb63SShri Abhyankar     ierr = VecScatterBegin(scat_act,Y_act,Y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1133d950fb63SShri Abhyankar     ierr = VecScatterEnd(scat_act,Y_act,Y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1134d950fb63SShri Abhyankar     ierr = VecScatterBegin(scat_inact,Y_inact,Y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1135d950fb63SShri Abhyankar     ierr = VecScatterEnd(scat_inact,Y_inact,Y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1136d950fb63SShri Abhyankar 
1137d950fb63SShri Abhyankar     ierr = VecDestroy(phi_inact);CHKERRQ(ierr);
1138d950fb63SShri Abhyankar     ierr = VecDestroy(Y_act);CHKERRQ(ierr);
1139d950fb63SShri Abhyankar     ierr = VecDestroy(Y_inact);CHKERRQ(ierr);
1140d950fb63SShri Abhyankar     ierr = VecScatterDestroy(scat_act);CHKERRQ(ierr);
1141d950fb63SShri Abhyankar     ierr = VecScatterDestroy(scat_inact);CHKERRQ(ierr);
1142d950fb63SShri Abhyankar     ierr = ISDestroy(IS_act);CHKERRQ(ierr);
1143d950fb63SShri Abhyankar     ierr = ISDestroy(IS_inact);CHKERRQ(ierr);
1144d950fb63SShri Abhyankar     ierr = MatDestroy(jac_inact_inact);CHKERRQ(ierr);
1145d950fb63SShri Abhyankar     if (snes->jacobian != snes->jacobian_pre) {
1146d950fb63SShri Abhyankar       ierr = MatDestroy(prejac_inact_inact);CHKERRQ(ierr);
1147d950fb63SShri Abhyankar     }
1148d950fb63SShri Abhyankar 
1149d950fb63SShri Abhyankar     ierr = KSPGetIterationNumber(snes->ksp,&lits);CHKERRQ(ierr);
1150d950fb63SShri Abhyankar     snes->linear_its += lits;
1151d950fb63SShri Abhyankar     ierr = PetscInfo2(snes,"iter=%D, linear solve iterations=%D\n",snes->iter,lits);CHKERRQ(ierr);
1152d950fb63SShri Abhyankar     /*
1153d950fb63SShri Abhyankar     if (vi->precheckstep) {
1154d950fb63SShri Abhyankar       PetscBool changed_y = PETSC_FALSE;
1155d950fb63SShri Abhyankar       ierr = (*vi->precheckstep)(snes,X,Y,vi->precheck,&changed_y);CHKERRQ(ierr);
1156d950fb63SShri Abhyankar     }
1157d950fb63SShri Abhyankar 
1158d950fb63SShri Abhyankar     if (PetscLogPrintInfo){
1159d950fb63SShri Abhyankar       ierr = SNESVICheckResidual_Private(snes,snes->jacobian,F,Y,G,W);CHKERRQ(ierr);
1160d950fb63SShri Abhyankar     }
1161d950fb63SShri Abhyankar     */
1162d950fb63SShri Abhyankar     /* Compute a (scaled) negative update in the line search routine:
1163d950fb63SShri Abhyankar          Y <- X - lambda*Y
1164d950fb63SShri Abhyankar        and evaluate G = function(Y) (depends on the line search).
1165d950fb63SShri Abhyankar     */
1166d950fb63SShri Abhyankar     ierr = VecCopy(Y,snes->vec_sol_update);CHKERRQ(ierr);
1167d950fb63SShri Abhyankar     ynorm = 1; gnorm = vi->phinorm;
1168d950fb63SShri Abhyankar     ierr = (*vi->LineSearch)(snes,vi->lsP,X,vi->phi,G,Y,W,vi->phinorm,xnorm,&ynorm,&gnorm,&lssucceed);CHKERRQ(ierr);
1169d950fb63SShri Abhyankar     ierr = PetscInfo4(snes,"fnorm=%18.16e, gnorm=%18.16e, ynorm=%18.16e, lssucceed=%d\n",vi->phinorm,gnorm,ynorm,(int)lssucceed);CHKERRQ(ierr);
1170d950fb63SShri Abhyankar     if (snes->reason == SNES_DIVERGED_FUNCTION_COUNT) break;
1171d950fb63SShri Abhyankar     if (snes->domainerror) {
1172d950fb63SShri Abhyankar       snes->reason = SNES_DIVERGED_FUNCTION_DOMAIN;
1173d950fb63SShri Abhyankar       PetscFunctionReturn(0);
1174d950fb63SShri Abhyankar     }
1175d950fb63SShri Abhyankar     if (!lssucceed) {
1176d950fb63SShri Abhyankar       if (++snes->numFailures >= snes->maxFailures) {
1177d950fb63SShri Abhyankar 	PetscBool ismin;
1178d950fb63SShri Abhyankar         snes->reason = SNES_DIVERGED_LINE_SEARCH;
1179d950fb63SShri Abhyankar         ierr = SNESVICheckLocalMin_Private(snes,snes->jacobian,G,W,gnorm,&ismin);CHKERRQ(ierr);
1180d950fb63SShri Abhyankar         if (ismin) snes->reason = SNES_DIVERGED_LOCAL_MIN;
1181d950fb63SShri Abhyankar         break;
1182d950fb63SShri Abhyankar       }
1183d950fb63SShri Abhyankar     }
1184d950fb63SShri Abhyankar     /* Update function and solution vectors */
1185d950fb63SShri Abhyankar     vi->phinorm = gnorm;
1186d950fb63SShri Abhyankar     vi->merit = 0.5*vi->phinorm*vi->phinorm;
1187d950fb63SShri Abhyankar     ierr = VecCopy(G,vi->phi);CHKERRQ(ierr);
1188d950fb63SShri Abhyankar     ierr = VecCopy(W,X);CHKERRQ(ierr);
1189d950fb63SShri Abhyankar     /* Monitor convergence */
1190d950fb63SShri Abhyankar     ierr = PetscObjectTakeAccess(snes);CHKERRQ(ierr);
1191d950fb63SShri Abhyankar     snes->iter = i+1;
1192d950fb63SShri Abhyankar     snes->norm = vi->phinorm;
1193d950fb63SShri Abhyankar     ierr = PetscObjectGrantAccess(snes);CHKERRQ(ierr);
1194d950fb63SShri Abhyankar     SNESLogConvHistory(snes,snes->norm,lits);
1195d950fb63SShri Abhyankar     SNESMonitor(snes,snes->iter,snes->norm);
1196d950fb63SShri Abhyankar     /* Test for convergence, xnorm = || X || */
1197d950fb63SShri Abhyankar     if (snes->ops->converged != SNESSkipConverged) { ierr = VecNorm(X,NORM_2,&xnorm);CHKERRQ(ierr); }
1198d950fb63SShri Abhyankar     ierr = (*snes->ops->converged)(snes,snes->iter,xnorm,ynorm,vi->phinorm,&snes->reason,snes->cnvP);CHKERRQ(ierr);
1199d950fb63SShri Abhyankar     if (snes->reason) break;
1200d950fb63SShri Abhyankar   }
1201d950fb63SShri Abhyankar   if (i == maxits) {
1202d950fb63SShri Abhyankar     ierr = PetscInfo1(snes,"Maximum number of iterations has been reached: %D\n",maxits);CHKERRQ(ierr);
1203d950fb63SShri Abhyankar     if(!snes->reason) snes->reason = SNES_DIVERGED_MAX_IT;
1204d950fb63SShri Abhyankar   }
1205d950fb63SShri Abhyankar   PetscFunctionReturn(0);
1206d950fb63SShri Abhyankar }
1207d950fb63SShri Abhyankar 
12082b4ed282SShri Abhyankar /* -------------------------------------------------------------------------- */
12092b4ed282SShri Abhyankar /*
12102b4ed282SShri Abhyankar    SNESSetUp_VI - Sets up the internal data structures for the later use
12112b4ed282SShri Abhyankar    of the SNESVI nonlinear solver.
12122b4ed282SShri Abhyankar 
12132b4ed282SShri Abhyankar    Input Parameter:
12142b4ed282SShri Abhyankar .  snes - the SNES context
12152b4ed282SShri Abhyankar .  x - the solution vector
12162b4ed282SShri Abhyankar 
12172b4ed282SShri Abhyankar    Application Interface Routine: SNESSetUp()
12182b4ed282SShri Abhyankar 
12192b4ed282SShri Abhyankar    Notes:
12202b4ed282SShri Abhyankar    For basic use of the SNES solvers, the user need not explicitly call
12212b4ed282SShri Abhyankar    SNESSetUp(), since these actions will automatically occur during
12222b4ed282SShri Abhyankar    the call to SNESSolve().
12232b4ed282SShri Abhyankar  */
12242b4ed282SShri Abhyankar #undef __FUNCT__
12252b4ed282SShri Abhyankar #define __FUNCT__ "SNESSetUp_VI"
12262b4ed282SShri Abhyankar PetscErrorCode SNESSetUp_VI(SNES snes)
12272b4ed282SShri Abhyankar {
12282b4ed282SShri Abhyankar   PetscErrorCode ierr;
12292b4ed282SShri Abhyankar   SNES_VI      *vi = (SNES_VI*) snes->data;
12302b4ed282SShri Abhyankar   PetscInt       i_start[3],i_end[3];
12312b4ed282SShri Abhyankar 
12322b4ed282SShri Abhyankar   PetscFunctionBegin;
12332b4ed282SShri Abhyankar   if (!snes->vec_sol_update) {
12342b4ed282SShri Abhyankar     ierr = VecDuplicate(snes->vec_sol,&snes->vec_sol_update);CHKERRQ(ierr);
12352b4ed282SShri Abhyankar     ierr = PetscLogObjectParent(snes,snes->vec_sol_update);CHKERRQ(ierr);
12362b4ed282SShri Abhyankar   }
12372b4ed282SShri Abhyankar   if (!snes->work) {
12382b4ed282SShri Abhyankar     snes->nwork = 3;
12392b4ed282SShri Abhyankar     ierr = VecDuplicateVecs(snes->vec_sol,snes->nwork,&snes->work);CHKERRQ(ierr);
12402b4ed282SShri Abhyankar     ierr = PetscLogObjectParents(snes,snes->nwork,snes->work);CHKERRQ(ierr);
12412b4ed282SShri Abhyankar   }
12422b4ed282SShri Abhyankar 
12432b4ed282SShri Abhyankar   ierr = VecDuplicate(snes->vec_sol, &vi->phi); CHKERRQ(ierr);
12442b4ed282SShri Abhyankar   ierr = VecDuplicate(snes->vec_sol, &vi->Da); CHKERRQ(ierr);
12452b4ed282SShri Abhyankar   ierr = VecDuplicate(snes->vec_sol, &vi->Db); CHKERRQ(ierr);
12462b4ed282SShri Abhyankar   ierr = VecDuplicate(snes->vec_sol, &vi->z);CHKERRQ(ierr);
12472b4ed282SShri Abhyankar   ierr = VecDuplicate(snes->vec_sol, &vi->t); CHKERRQ(ierr);
12482b4ed282SShri Abhyankar 
12492b4ed282SShri Abhyankar   /* If the lower and upper bound on variables are not set, set it to
12502b4ed282SShri Abhyankar      -Inf and Inf */
12512b4ed282SShri Abhyankar   if (!vi->xl && !vi->xu) {
12522b4ed282SShri Abhyankar     vi->usersetxbounds = PETSC_FALSE;
12532b4ed282SShri Abhyankar     ierr = VecDuplicate(snes->vec_sol, &vi->xl); CHKERRQ(ierr);
12542b4ed282SShri Abhyankar     ierr = VecSet(vi->xl,PETSC_VI_NINF);CHKERRQ(ierr);
12552b4ed282SShri Abhyankar     ierr = VecDuplicate(snes->vec_sol, &vi->xu); CHKERRQ(ierr);
12562b4ed282SShri Abhyankar     ierr = VecSet(vi->xu,PETSC_VI_INF);CHKERRQ(ierr);
12572b4ed282SShri Abhyankar   } else {
12582b4ed282SShri Abhyankar     /* Check if lower bound, upper bound and solution vector distribution across the processors is identical */
12592b4ed282SShri Abhyankar     ierr = VecGetOwnershipRange(snes->vec_sol,i_start,i_end);CHKERRQ(ierr);
12602b4ed282SShri Abhyankar     ierr = VecGetOwnershipRange(vi->xl,i_start+1,i_end+1);CHKERRQ(ierr);
12612b4ed282SShri Abhyankar     ierr = VecGetOwnershipRange(vi->xu,i_start+2,i_end+2);CHKERRQ(ierr);
12622b4ed282SShri 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]))
12632b4ed282SShri 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.");
12642b4ed282SShri Abhyankar   }
12652b4ed282SShri Abhyankar 
12662b4ed282SShri Abhyankar   vi->computeuserfunction = snes->ops->computefunction;
12671f79c099SShri Abhyankar   snes->ops->computefunction = SNESVIComputeFunction;
1268a79edbefSShri Abhyankar 
12692b4ed282SShri Abhyankar   PetscFunctionReturn(0);
12702b4ed282SShri Abhyankar }
12712b4ed282SShri Abhyankar /* -------------------------------------------------------------------------- */
12722b4ed282SShri Abhyankar /*
12732b4ed282SShri Abhyankar    SNESDestroy_VI - Destroys the private SNES_VI context that was created
12742b4ed282SShri Abhyankar    with SNESCreate_VI().
12752b4ed282SShri Abhyankar 
12762b4ed282SShri Abhyankar    Input Parameter:
12772b4ed282SShri Abhyankar .  snes - the SNES context
12782b4ed282SShri Abhyankar 
12792b4ed282SShri Abhyankar    Application Interface Routine: SNESDestroy()
12802b4ed282SShri Abhyankar  */
12812b4ed282SShri Abhyankar #undef __FUNCT__
12822b4ed282SShri Abhyankar #define __FUNCT__ "SNESDestroy_VI"
12832b4ed282SShri Abhyankar PetscErrorCode SNESDestroy_VI(SNES snes)
12842b4ed282SShri Abhyankar {
12852b4ed282SShri Abhyankar   SNES_VI        *vi = (SNES_VI*) snes->data;
12862b4ed282SShri Abhyankar   PetscErrorCode ierr;
12872b4ed282SShri Abhyankar 
12882b4ed282SShri Abhyankar   PetscFunctionBegin;
12892b4ed282SShri Abhyankar   if (snes->vec_sol_update) {
12902b4ed282SShri Abhyankar     ierr = VecDestroy(snes->vec_sol_update);CHKERRQ(ierr);
12912b4ed282SShri Abhyankar     snes->vec_sol_update = PETSC_NULL;
12922b4ed282SShri Abhyankar   }
12932b4ed282SShri Abhyankar   if (snes->nwork) {
12942b4ed282SShri Abhyankar     ierr = VecDestroyVecs(snes->work,snes->nwork);CHKERRQ(ierr);
12952b4ed282SShri Abhyankar     snes->nwork = 0;
12962b4ed282SShri Abhyankar     snes->work  = PETSC_NULL;
12972b4ed282SShri Abhyankar   }
12982b4ed282SShri Abhyankar 
12992b4ed282SShri Abhyankar   /* clear vectors */
13002b4ed282SShri Abhyankar   ierr = VecDestroy(vi->phi); CHKERRQ(ierr);
13012b4ed282SShri Abhyankar   ierr = VecDestroy(vi->Da); CHKERRQ(ierr);
13022b4ed282SShri Abhyankar   ierr = VecDestroy(vi->Db); CHKERRQ(ierr);
13032b4ed282SShri Abhyankar   ierr = VecDestroy(vi->z); CHKERRQ(ierr);
13042b4ed282SShri Abhyankar   ierr = VecDestroy(vi->t); CHKERRQ(ierr);
13052b4ed282SShri Abhyankar   if (!vi->usersetxbounds) {
13062b4ed282SShri Abhyankar     ierr = VecDestroy(vi->xl); CHKERRQ(ierr);
13072b4ed282SShri Abhyankar     ierr = VecDestroy(vi->xu); CHKERRQ(ierr);
13082b4ed282SShri Abhyankar   }
1309c92abb8aSShri Abhyankar   if (vi->lsmonitor) {
1310c92abb8aSShri Abhyankar     ierr = PetscViewerASCIIMonitorDestroy(vi->lsmonitor);CHKERRQ(ierr);
13112b4ed282SShri Abhyankar   }
13122b4ed282SShri Abhyankar   ierr = PetscFree(snes->data);CHKERRQ(ierr);
13132b4ed282SShri Abhyankar 
13142b4ed282SShri Abhyankar   /* clear composed functions */
13152b4ed282SShri Abhyankar   ierr = PetscObjectComposeFunctionDynamic((PetscObject)snes,"SNESLineSearchSet_C","",PETSC_NULL);CHKERRQ(ierr);
1316c92abb8aSShri Abhyankar   ierr = PetscObjectComposeFunctionDynamic((PetscObject)snes,"SNESLineSearchSetMonitor_C","",PETSC_NULL);CHKERRQ(ierr);
13172b4ed282SShri Abhyankar   PetscFunctionReturn(0);
13182b4ed282SShri Abhyankar }
13192b4ed282SShri Abhyankar /* -------------------------------------------------------------------------- */
13202b4ed282SShri Abhyankar #undef __FUNCT__
13212b4ed282SShri Abhyankar #define __FUNCT__ "SNESLineSearchNo_VI"
13222b4ed282SShri Abhyankar 
13232b4ed282SShri Abhyankar /*
13242b4ed282SShri Abhyankar   This routine is a copy of SNESLineSearchNo routine in snes/impls/ls/ls.c
13252b4ed282SShri Abhyankar 
13262b4ed282SShri Abhyankar */
1327ace3abfcSBarry 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)
13282b4ed282SShri Abhyankar {
13292b4ed282SShri Abhyankar   PetscErrorCode ierr;
13302b4ed282SShri Abhyankar   SNES_VI        *vi = (SNES_VI*)snes->data;
1331ace3abfcSBarry Smith   PetscBool     changed_w = PETSC_FALSE,changed_y = PETSC_FALSE;
13322b4ed282SShri Abhyankar 
13332b4ed282SShri Abhyankar   PetscFunctionBegin;
13342b4ed282SShri Abhyankar   *flag = PETSC_TRUE;
13352b4ed282SShri Abhyankar   ierr = PetscLogEventBegin(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr);
13362b4ed282SShri Abhyankar   ierr = VecNorm(y,NORM_2,ynorm);CHKERRQ(ierr);         /* ynorm = || y || */
13372b4ed282SShri Abhyankar   ierr = VecWAXPY(w,-1.0,y,x);CHKERRQ(ierr);            /* w <- x - y   */
13382b4ed282SShri Abhyankar   if (vi->postcheckstep) {
13392b4ed282SShri Abhyankar    ierr = (*vi->postcheckstep)(snes,x,y,w,vi->postcheck,&changed_y,&changed_w);CHKERRQ(ierr);
13402b4ed282SShri Abhyankar   }
13412b4ed282SShri Abhyankar   if (changed_y) {
13422b4ed282SShri Abhyankar     ierr = VecWAXPY(w,-1.0,y,x);CHKERRQ(ierr);            /* w <- x - y   */
13432b4ed282SShri Abhyankar   }
13442b4ed282SShri Abhyankar   ierr = SNESComputeFunction(snes,w,g);CHKERRQ(ierr);
13452b4ed282SShri Abhyankar   if (!snes->domainerror) {
13462b4ed282SShri Abhyankar     ierr = VecNorm(g,NORM_2,gnorm);CHKERRQ(ierr);  /* gnorm = || g || */
13472b4ed282SShri Abhyankar     if PetscIsInfOrNanReal(*gnorm) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FP,"User provided compute function generated a Not-a-Number");
13482b4ed282SShri Abhyankar   }
1349c92abb8aSShri Abhyankar   if (vi->lsmonitor) {
1350c92abb8aSShri Abhyankar     ierr = PetscViewerASCIIMonitorPrintf(vi->lsmonitor,"    Line search: Using full step: fnorm %G gnorm %G\n",fnorm,*gnorm);CHKERRQ(ierr);
1351c92abb8aSShri Abhyankar   }
13522b4ed282SShri Abhyankar   ierr = PetscLogEventEnd(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr);
13532b4ed282SShri Abhyankar   PetscFunctionReturn(0);
13542b4ed282SShri Abhyankar }
13552b4ed282SShri Abhyankar 
13562b4ed282SShri Abhyankar /* -------------------------------------------------------------------------- */
13572b4ed282SShri Abhyankar #undef __FUNCT__
13582b4ed282SShri Abhyankar #define __FUNCT__ "SNESLineSearchNoNorms_VI"
13592b4ed282SShri Abhyankar 
13602b4ed282SShri Abhyankar /*
13612b4ed282SShri Abhyankar   This routine is a copy of SNESLineSearchNoNorms in snes/impls/ls/ls.c
13622b4ed282SShri Abhyankar */
1363ace3abfcSBarry 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)
13642b4ed282SShri Abhyankar {
13652b4ed282SShri Abhyankar   PetscErrorCode ierr;
13662b4ed282SShri Abhyankar   SNES_VI        *vi = (SNES_VI*)snes->data;
1367ace3abfcSBarry Smith   PetscBool     changed_w = PETSC_FALSE,changed_y = PETSC_FALSE;
13682b4ed282SShri Abhyankar 
13692b4ed282SShri Abhyankar   PetscFunctionBegin;
13702b4ed282SShri Abhyankar   *flag = PETSC_TRUE;
13712b4ed282SShri Abhyankar   ierr = PetscLogEventBegin(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr);
13722b4ed282SShri Abhyankar   ierr = VecWAXPY(w,-1.0,y,x);CHKERRQ(ierr);            /* w <- x - y      */
13732b4ed282SShri Abhyankar   if (vi->postcheckstep) {
13742b4ed282SShri Abhyankar    ierr = (*vi->postcheckstep)(snes,x,y,w,vi->postcheck,&changed_y,&changed_w);CHKERRQ(ierr);
13752b4ed282SShri Abhyankar   }
13762b4ed282SShri Abhyankar   if (changed_y) {
13772b4ed282SShri Abhyankar     ierr = VecWAXPY(w,-1.0,y,x);CHKERRQ(ierr);            /* w <- x - y   */
13782b4ed282SShri Abhyankar   }
13792b4ed282SShri Abhyankar 
13802b4ed282SShri Abhyankar   /* don't evaluate function the last time through */
13812b4ed282SShri Abhyankar   if (snes->iter < snes->max_its-1) {
13822b4ed282SShri Abhyankar     ierr = SNESComputeFunction(snes,w,g);CHKERRQ(ierr);
13832b4ed282SShri Abhyankar   }
13842b4ed282SShri Abhyankar   ierr = PetscLogEventEnd(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr);
13852b4ed282SShri Abhyankar   PetscFunctionReturn(0);
13862b4ed282SShri Abhyankar }
13872b4ed282SShri Abhyankar /* -------------------------------------------------------------------------- */
13882b4ed282SShri Abhyankar #undef __FUNCT__
13892b4ed282SShri Abhyankar #define __FUNCT__ "SNESLineSearchCubic_VI"
13902b4ed282SShri Abhyankar /*
13912b4ed282SShri Abhyankar   This routine is a copy of SNESLineSearchCubic in snes/impls/ls/ls.c
13922b4ed282SShri Abhyankar */
1393ace3abfcSBarry 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)
13942b4ed282SShri Abhyankar {
13952b4ed282SShri Abhyankar   /*
13962b4ed282SShri Abhyankar      Note that for line search purposes we work with with the related
13972b4ed282SShri Abhyankar      minimization problem:
13982b4ed282SShri Abhyankar         min  z(x):  R^n -> R,
13992b4ed282SShri Abhyankar      where z(x) = .5 * fnorm*fnorm, and fnorm = || f ||_2.
14002b4ed282SShri Abhyankar      This function z(x) is same as the merit function for the complementarity problem.
14012b4ed282SShri Abhyankar    */
14022b4ed282SShri Abhyankar 
14032b4ed282SShri Abhyankar   PetscReal      initslope,lambdaprev,gnormprev,a,b,d,t1,t2,rellength;
14042b4ed282SShri Abhyankar   PetscReal      minlambda,lambda,lambdatemp;
14052b4ed282SShri Abhyankar #if defined(PETSC_USE_COMPLEX)
14062b4ed282SShri Abhyankar   PetscScalar    cinitslope;
14072b4ed282SShri Abhyankar #endif
14082b4ed282SShri Abhyankar   PetscErrorCode ierr;
14092b4ed282SShri Abhyankar   PetscInt       count;
14102b4ed282SShri Abhyankar   SNES_VI      *vi = (SNES_VI*)snes->data;
1411ace3abfcSBarry Smith   PetscBool     changed_w = PETSC_FALSE,changed_y = PETSC_FALSE;
14122b4ed282SShri Abhyankar   MPI_Comm       comm;
14132b4ed282SShri Abhyankar 
14142b4ed282SShri Abhyankar   PetscFunctionBegin;
14152b4ed282SShri Abhyankar   ierr = PetscObjectGetComm((PetscObject)snes,&comm);CHKERRQ(ierr);
14162b4ed282SShri Abhyankar   ierr = PetscLogEventBegin(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr);
14172b4ed282SShri Abhyankar   *flag   = PETSC_TRUE;
14182b4ed282SShri Abhyankar 
14192b4ed282SShri Abhyankar   ierr = VecNorm(y,NORM_2,ynorm);CHKERRQ(ierr);
14202b4ed282SShri Abhyankar   if (*ynorm == 0.0) {
1421c92abb8aSShri Abhyankar     if (vi->lsmonitor) {
1422c92abb8aSShri Abhyankar       ierr = PetscViewerASCIIMonitorPrintf(vi->lsmonitor,"    Line search: Initial direction and size is 0\n");CHKERRQ(ierr);
14232b4ed282SShri Abhyankar     }
14242b4ed282SShri Abhyankar     *gnorm = fnorm;
14252b4ed282SShri Abhyankar     ierr   = VecCopy(x,w);CHKERRQ(ierr);
14262b4ed282SShri Abhyankar     ierr   = VecCopy(f,g);CHKERRQ(ierr);
14272b4ed282SShri Abhyankar     *flag  = PETSC_FALSE;
14282b4ed282SShri Abhyankar     goto theend1;
14292b4ed282SShri Abhyankar   }
14302b4ed282SShri Abhyankar   if (*ynorm > vi->maxstep) {	/* Step too big, so scale back */
1431c92abb8aSShri Abhyankar     if (vi->lsmonitor) {
1432c92abb8aSShri Abhyankar       ierr = PetscViewerASCIIMonitorPrintf(vi->lsmonitor,"    Line search: Scaling step by %G old ynorm %G\n",vi->maxstep/(*ynorm),*ynorm);CHKERRQ(ierr);
14332b4ed282SShri Abhyankar     }
14342b4ed282SShri Abhyankar     ierr = VecScale(y,vi->maxstep/(*ynorm));CHKERRQ(ierr);
14352b4ed282SShri Abhyankar     *ynorm = vi->maxstep;
14362b4ed282SShri Abhyankar   }
14372b4ed282SShri Abhyankar   ierr      = VecMaxPointwiseDivide(y,x,&rellength);CHKERRQ(ierr);
14382b4ed282SShri Abhyankar   minlambda = vi->minlambda/rellength;
14393b336b49SShri Abhyankar   ierr      = MatMult(snes->jacobian,y,w);CHKERRQ(ierr);
14402b4ed282SShri Abhyankar #if defined(PETSC_USE_COMPLEX)
14413b336b49SShri Abhyankar   ierr      = VecDot(f,w,&cinitslope);CHKERRQ(ierr);
14422b4ed282SShri Abhyankar   initslope = PetscRealPart(cinitslope);
14432b4ed282SShri Abhyankar #else
14443b336b49SShri Abhyankar   ierr      = VecDot(f,w,&initslope);CHKERRQ(ierr);
14452b4ed282SShri Abhyankar #endif
14462b4ed282SShri Abhyankar   if (initslope > 0.0)  initslope = -initslope;
14472b4ed282SShri Abhyankar   if (initslope == 0.0) initslope = -1.0;
14482b4ed282SShri Abhyankar 
14492b4ed282SShri Abhyankar   ierr = VecWAXPY(w,-1.0,y,x);CHKERRQ(ierr);
14502b4ed282SShri Abhyankar   if (snes->nfuncs >= snes->max_funcs) {
14512b4ed282SShri Abhyankar     ierr  = PetscInfo(snes,"Exceeded maximum function evaluations, while checking full step length!\n");CHKERRQ(ierr);
14522b4ed282SShri Abhyankar     *flag = PETSC_FALSE;
14532b4ed282SShri Abhyankar     snes->reason = SNES_DIVERGED_FUNCTION_COUNT;
14542b4ed282SShri Abhyankar     goto theend1;
14552b4ed282SShri Abhyankar   }
14562b4ed282SShri Abhyankar   ierr = SNESComputeFunction(snes,w,g);CHKERRQ(ierr);
14572b4ed282SShri Abhyankar   if (snes->domainerror) {
14582b4ed282SShri Abhyankar     ierr = PetscLogEventEnd(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr);
14592b4ed282SShri Abhyankar     PetscFunctionReturn(0);
14602b4ed282SShri Abhyankar   }
14612b4ed282SShri Abhyankar   ierr = VecNorm(g,NORM_2,gnorm);CHKERRQ(ierr);
14622b4ed282SShri Abhyankar   if PetscIsInfOrNanReal(*gnorm) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FP,"User provided compute function generated a Not-a-Number");
14632b4ed282SShri Abhyankar   ierr = PetscInfo2(snes,"Initial fnorm %G gnorm %G\n",fnorm,*gnorm);CHKERRQ(ierr);
14642b4ed282SShri Abhyankar   if (.5*(*gnorm)*(*gnorm) <= .5*fnorm*fnorm + vi->alpha*initslope) { /* Sufficient reduction */
1465c92abb8aSShri Abhyankar     if (vi->lsmonitor) {
1466c92abb8aSShri Abhyankar       ierr = PetscViewerASCIIMonitorPrintf(vi->lsmonitor,"    Line search: Using full step: fnorm %G gnorm %G\n",fnorm,*gnorm);CHKERRQ(ierr);
14672b4ed282SShri Abhyankar     }
14682b4ed282SShri Abhyankar     goto theend1;
14692b4ed282SShri Abhyankar   }
14702b4ed282SShri Abhyankar 
14712b4ed282SShri Abhyankar   /* Fit points with quadratic */
14722b4ed282SShri Abhyankar   lambda     = 1.0;
14732b4ed282SShri Abhyankar   lambdatemp = -initslope/((*gnorm)*(*gnorm) - fnorm*fnorm - 2.0*initslope);
14742b4ed282SShri Abhyankar   lambdaprev = lambda;
14752b4ed282SShri Abhyankar   gnormprev  = *gnorm;
14762b4ed282SShri Abhyankar   if (lambdatemp > .5*lambda)  lambdatemp = .5*lambda;
14772b4ed282SShri Abhyankar   if (lambdatemp <= .1*lambda) lambda = .1*lambda;
14782b4ed282SShri Abhyankar   else                         lambda = lambdatemp;
14792b4ed282SShri Abhyankar 
14802b4ed282SShri Abhyankar   ierr  = VecWAXPY(w,-lambda,y,x);CHKERRQ(ierr);
14812b4ed282SShri Abhyankar   if (snes->nfuncs >= snes->max_funcs) {
14822b4ed282SShri Abhyankar     ierr  = PetscInfo1(snes,"Exceeded maximum function evaluations, while attempting quadratic backtracking! %D \n",snes->nfuncs);CHKERRQ(ierr);
14832b4ed282SShri Abhyankar     *flag = PETSC_FALSE;
14842b4ed282SShri Abhyankar     snes->reason = SNES_DIVERGED_FUNCTION_COUNT;
14852b4ed282SShri Abhyankar     goto theend1;
14862b4ed282SShri Abhyankar   }
14872b4ed282SShri Abhyankar   ierr = SNESComputeFunction(snes,w,g);CHKERRQ(ierr);
14882b4ed282SShri Abhyankar   if (snes->domainerror) {
14892b4ed282SShri Abhyankar     ierr = PetscLogEventEnd(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr);
14902b4ed282SShri Abhyankar     PetscFunctionReturn(0);
14912b4ed282SShri Abhyankar   }
14922b4ed282SShri Abhyankar   ierr = VecNorm(g,NORM_2,gnorm);CHKERRQ(ierr);
14932b4ed282SShri Abhyankar   if PetscIsInfOrNanReal(*gnorm) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FP,"User provided compute function generated a Not-a-Number");
1494c92abb8aSShri Abhyankar   if (vi->lsmonitor) {
1495c92abb8aSShri Abhyankar     ierr = PetscViewerASCIIMonitorPrintf(vi->lsmonitor,"    Line search: gnorm after quadratic fit %G\n",*gnorm);CHKERRQ(ierr);
14962b4ed282SShri Abhyankar   }
14972b4ed282SShri Abhyankar   if (.5*(*gnorm)*(*gnorm) < .5*fnorm*fnorm + lambda*vi->alpha*initslope) { /* sufficient reduction */
1498c92abb8aSShri Abhyankar     if (vi->lsmonitor) {
1499c92abb8aSShri Abhyankar       ierr = PetscViewerASCIIMonitorPrintf(vi->lsmonitor,"    Line search: Quadratically determined step, lambda=%18.16e\n",lambda);CHKERRQ(ierr);
15002b4ed282SShri Abhyankar     }
15012b4ed282SShri Abhyankar     goto theend1;
15022b4ed282SShri Abhyankar   }
15032b4ed282SShri Abhyankar 
15042b4ed282SShri Abhyankar   /* Fit points with cubic */
15052b4ed282SShri Abhyankar   count = 1;
15062b4ed282SShri Abhyankar   while (PETSC_TRUE) {
15072b4ed282SShri Abhyankar     if (lambda <= minlambda) {
1508c92abb8aSShri Abhyankar       if (vi->lsmonitor) {
1509c92abb8aSShri Abhyankar 	ierr = PetscViewerASCIIMonitorPrintf(vi->lsmonitor,"    Line search: unable to find good step length! After %D tries \n",count);CHKERRQ(ierr);
1510c92abb8aSShri 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);
15112b4ed282SShri Abhyankar       }
15122b4ed282SShri Abhyankar       *flag = PETSC_FALSE;
15132b4ed282SShri Abhyankar       break;
15142b4ed282SShri Abhyankar     }
15152b4ed282SShri Abhyankar     t1 = .5*((*gnorm)*(*gnorm) - fnorm*fnorm) - lambda*initslope;
15162b4ed282SShri Abhyankar     t2 = .5*(gnormprev*gnormprev  - fnorm*fnorm) - lambdaprev*initslope;
15172b4ed282SShri Abhyankar     a  = (t1/(lambda*lambda) - t2/(lambdaprev*lambdaprev))/(lambda-lambdaprev);
15182b4ed282SShri Abhyankar     b  = (-lambdaprev*t1/(lambda*lambda) + lambda*t2/(lambdaprev*lambdaprev))/(lambda-lambdaprev);
15192b4ed282SShri Abhyankar     d  = b*b - 3*a*initslope;
15202b4ed282SShri Abhyankar     if (d < 0.0) d = 0.0;
15212b4ed282SShri Abhyankar     if (a == 0.0) {
15222b4ed282SShri Abhyankar       lambdatemp = -initslope/(2.0*b);
15232b4ed282SShri Abhyankar     } else {
15242b4ed282SShri Abhyankar       lambdatemp = (-b + sqrt(d))/(3.0*a);
15252b4ed282SShri Abhyankar     }
15262b4ed282SShri Abhyankar     lambdaprev = lambda;
15272b4ed282SShri Abhyankar     gnormprev  = *gnorm;
15282b4ed282SShri Abhyankar     if (lambdatemp > .5*lambda)  lambdatemp = .5*lambda;
15292b4ed282SShri Abhyankar     if (lambdatemp <= .1*lambda) lambda     = .1*lambda;
15302b4ed282SShri Abhyankar     else                         lambda     = lambdatemp;
15312b4ed282SShri Abhyankar     ierr  = VecWAXPY(w,-lambda,y,x);CHKERRQ(ierr);
15322b4ed282SShri Abhyankar     if (snes->nfuncs >= snes->max_funcs) {
15332b4ed282SShri Abhyankar       ierr = PetscInfo1(snes,"Exceeded maximum function evaluations, while looking for good step length! %D \n",count);CHKERRQ(ierr);
15342b4ed282SShri 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);
15352b4ed282SShri Abhyankar       *flag = PETSC_FALSE;
15362b4ed282SShri Abhyankar       snes->reason = SNES_DIVERGED_FUNCTION_COUNT;
15372b4ed282SShri Abhyankar       break;
15382b4ed282SShri Abhyankar     }
15392b4ed282SShri Abhyankar     ierr = SNESComputeFunction(snes,w,g);CHKERRQ(ierr);
15402b4ed282SShri Abhyankar     if (snes->domainerror) {
15412b4ed282SShri Abhyankar       ierr = PetscLogEventEnd(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr);
15422b4ed282SShri Abhyankar       PetscFunctionReturn(0);
15432b4ed282SShri Abhyankar     }
15442b4ed282SShri Abhyankar     ierr = VecNorm(g,NORM_2,gnorm);CHKERRQ(ierr);
15452b4ed282SShri Abhyankar     if PetscIsInfOrNanReal(*gnorm) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FP,"User provided compute function generated a Not-a-Number");
15462b4ed282SShri Abhyankar     if (.5*(*gnorm)*(*gnorm) < .5*fnorm*fnorm + lambda*vi->alpha*initslope) { /* is reduction enough? */
1547c92abb8aSShri Abhyankar       if (vi->lsmonitor) {
15482b4ed282SShri Abhyankar 	ierr = PetscPrintf(comm,"    Line search: Cubically determined step, current gnorm %G lambda=%18.16e\n",*gnorm,lambda);CHKERRQ(ierr);
15492b4ed282SShri Abhyankar       }
15502b4ed282SShri Abhyankar       break;
15512b4ed282SShri Abhyankar     } else {
1552c92abb8aSShri Abhyankar       if (vi->lsmonitor) {
15532b4ed282SShri Abhyankar         ierr = PetscPrintf(comm,"    Line search: Cubic step no good, shrinking lambda, current gnorm %G lambda=%18.16e\n",*gnorm,lambda);CHKERRQ(ierr);
15542b4ed282SShri Abhyankar       }
15552b4ed282SShri Abhyankar     }
15562b4ed282SShri Abhyankar     count++;
15572b4ed282SShri Abhyankar   }
15582b4ed282SShri Abhyankar   theend1:
15592b4ed282SShri Abhyankar   /* Optional user-defined check for line search step validity */
15602b4ed282SShri Abhyankar   if (vi->postcheckstep && *flag) {
15612b4ed282SShri Abhyankar     ierr = (*vi->postcheckstep)(snes,x,y,w,vi->postcheck,&changed_y,&changed_w);CHKERRQ(ierr);
15622b4ed282SShri Abhyankar     if (changed_y) {
15632b4ed282SShri Abhyankar       ierr = VecWAXPY(w,-1.0,y,x);CHKERRQ(ierr);
15642b4ed282SShri Abhyankar     }
15652b4ed282SShri Abhyankar     if (changed_y || changed_w) { /* recompute the function if the step has changed */
15662b4ed282SShri Abhyankar       ierr = SNESComputeFunction(snes,w,g);CHKERRQ(ierr);
15672b4ed282SShri Abhyankar       if (snes->domainerror) {
15682b4ed282SShri Abhyankar         ierr = PetscLogEventEnd(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr);
15692b4ed282SShri Abhyankar         PetscFunctionReturn(0);
15702b4ed282SShri Abhyankar       }
15712b4ed282SShri Abhyankar       ierr = VecNormBegin(g,NORM_2,gnorm);CHKERRQ(ierr);
15722b4ed282SShri Abhyankar       if PetscIsInfOrNanReal(*gnorm) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FP,"User provided compute function generated a Not-a-Number");
15732b4ed282SShri Abhyankar       ierr = VecNormBegin(y,NORM_2,ynorm);CHKERRQ(ierr);
15742b4ed282SShri Abhyankar       ierr = VecNormEnd(g,NORM_2,gnorm);CHKERRQ(ierr);
15752b4ed282SShri Abhyankar       ierr = VecNormEnd(y,NORM_2,ynorm);CHKERRQ(ierr);
15762b4ed282SShri Abhyankar     }
15772b4ed282SShri Abhyankar   }
15782b4ed282SShri Abhyankar   ierr = PetscLogEventEnd(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr);
15792b4ed282SShri Abhyankar   PetscFunctionReturn(0);
15802b4ed282SShri Abhyankar }
15812b4ed282SShri Abhyankar /* -------------------------------------------------------------------------- */
15822b4ed282SShri Abhyankar #undef __FUNCT__
15832b4ed282SShri Abhyankar #define __FUNCT__ "SNESLineSearchQuadratic_VI"
15842b4ed282SShri Abhyankar /*
15852b4ed282SShri Abhyankar   This routine is a copy of SNESLineSearchQuadratic in snes/impls/ls/ls.c
15862b4ed282SShri Abhyankar */
1587ace3abfcSBarry 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)
15882b4ed282SShri Abhyankar {
15892b4ed282SShri Abhyankar   /*
15902b4ed282SShri Abhyankar      Note that for line search purposes we work with with the related
15912b4ed282SShri Abhyankar      minimization problem:
15922b4ed282SShri Abhyankar         min  z(x):  R^n -> R,
15932b4ed282SShri Abhyankar      where z(x) = .5 * fnorm*fnorm,and fnorm = || f ||_2.
15942b4ed282SShri Abhyankar      z(x) is the same as the merit function for the complementarity problem
15952b4ed282SShri Abhyankar    */
15962b4ed282SShri Abhyankar   PetscReal      initslope,minlambda,lambda,lambdatemp,rellength;
15972b4ed282SShri Abhyankar #if defined(PETSC_USE_COMPLEX)
15982b4ed282SShri Abhyankar   PetscScalar    cinitslope;
15992b4ed282SShri Abhyankar #endif
16002b4ed282SShri Abhyankar   PetscErrorCode ierr;
16012b4ed282SShri Abhyankar   PetscInt       count;
16022b4ed282SShri Abhyankar   SNES_VI        *vi = (SNES_VI*)snes->data;
1603ace3abfcSBarry Smith   PetscBool     changed_w = PETSC_FALSE,changed_y = PETSC_FALSE;
16042b4ed282SShri Abhyankar 
16052b4ed282SShri Abhyankar   PetscFunctionBegin;
16062b4ed282SShri Abhyankar   ierr    = PetscLogEventBegin(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr);
16072b4ed282SShri Abhyankar   *flag   = PETSC_TRUE;
16082b4ed282SShri Abhyankar 
16092b4ed282SShri Abhyankar   ierr = VecNorm(y,NORM_2,ynorm);CHKERRQ(ierr);
16102b4ed282SShri Abhyankar   if (*ynorm == 0.0) {
1611c92abb8aSShri Abhyankar     if (vi->lsmonitor) {
1612c92abb8aSShri Abhyankar       ierr = PetscViewerASCIIMonitorPrintf(vi->lsmonitor,"Line search: Direction and size is 0\n");CHKERRQ(ierr);
16132b4ed282SShri Abhyankar     }
16142b4ed282SShri Abhyankar     *gnorm = fnorm;
16152b4ed282SShri Abhyankar     ierr   = VecCopy(x,w);CHKERRQ(ierr);
16162b4ed282SShri Abhyankar     ierr   = VecCopy(f,g);CHKERRQ(ierr);
16172b4ed282SShri Abhyankar     *flag  = PETSC_FALSE;
16182b4ed282SShri Abhyankar     goto theend2;
16192b4ed282SShri Abhyankar   }
16202b4ed282SShri Abhyankar   if (*ynorm > vi->maxstep) {	/* Step too big, so scale back */
16212b4ed282SShri Abhyankar     ierr   = VecScale(y,vi->maxstep/(*ynorm));CHKERRQ(ierr);
16222b4ed282SShri Abhyankar     *ynorm = vi->maxstep;
16232b4ed282SShri Abhyankar   }
16242b4ed282SShri Abhyankar   ierr      = VecMaxPointwiseDivide(y,x,&rellength);CHKERRQ(ierr);
16252b4ed282SShri Abhyankar   minlambda = vi->minlambda/rellength;
16263b336b49SShri Abhyankar   ierr = MatMult(snes->jacobian,y,w);CHKERRQ(ierr);
16272b4ed282SShri Abhyankar #if defined(PETSC_USE_COMPLEX)
16282b4ed282SShri Abhyankar   ierr      = VecDot(f,w,&cinitslope);CHKERRQ(ierr);
16292b4ed282SShri Abhyankar   initslope = PetscRealPart(cinitslope);
16302b4ed282SShri Abhyankar #else
16313b336b49SShri Abhyankar   ierr = VecDot(f,w,&initslope);CHKERRQ(ierr);
16322b4ed282SShri Abhyankar #endif
16332b4ed282SShri Abhyankar   if (initslope > 0.0)  initslope = -initslope;
16342b4ed282SShri Abhyankar   if (initslope == 0.0) initslope = -1.0;
16352b4ed282SShri Abhyankar   ierr = PetscInfo1(snes,"Initslope %G \n",initslope);CHKERRQ(ierr);
16362b4ed282SShri Abhyankar 
16372b4ed282SShri Abhyankar   ierr = VecWAXPY(w,-1.0,y,x);CHKERRQ(ierr);
16382b4ed282SShri Abhyankar   if (snes->nfuncs >= snes->max_funcs) {
16392b4ed282SShri Abhyankar     ierr  = PetscInfo(snes,"Exceeded maximum function evaluations, while checking full step length!\n");CHKERRQ(ierr);
16402b4ed282SShri Abhyankar     *flag = PETSC_FALSE;
16412b4ed282SShri Abhyankar     snes->reason = SNES_DIVERGED_FUNCTION_COUNT;
16422b4ed282SShri Abhyankar     goto theend2;
16432b4ed282SShri Abhyankar   }
16442b4ed282SShri Abhyankar   ierr = SNESComputeFunction(snes,w,g);CHKERRQ(ierr);
16452b4ed282SShri Abhyankar   if (snes->domainerror) {
16462b4ed282SShri Abhyankar     ierr = PetscLogEventEnd(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr);
16472b4ed282SShri Abhyankar     PetscFunctionReturn(0);
16482b4ed282SShri Abhyankar   }
16492b4ed282SShri Abhyankar   ierr = VecNorm(g,NORM_2,gnorm);CHKERRQ(ierr);
16502b4ed282SShri Abhyankar   if PetscIsInfOrNanReal(*gnorm) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FP,"User provided compute function generated a Not-a-Number");
16512b4ed282SShri Abhyankar   if (.5*(*gnorm)*(*gnorm) <= .5*fnorm*fnorm + vi->alpha*initslope) { /* Sufficient reduction */
1652c92abb8aSShri Abhyankar     if (vi->lsmonitor) {
1653c92abb8aSShri Abhyankar       ierr = PetscViewerASCIIMonitorPrintf(vi->lsmonitor,"    Line search: Using full step: fnorm %G gnorm %G\n",fnorm,*gnorm);CHKERRQ(ierr);
16542b4ed282SShri Abhyankar     }
16552b4ed282SShri Abhyankar     goto theend2;
16562b4ed282SShri Abhyankar   }
16572b4ed282SShri Abhyankar 
16582b4ed282SShri Abhyankar   /* Fit points with quadratic */
16592b4ed282SShri Abhyankar   lambda = 1.0;
16602b4ed282SShri Abhyankar   count = 1;
16612b4ed282SShri Abhyankar   while (PETSC_TRUE) {
16622b4ed282SShri Abhyankar     if (lambda <= minlambda) { /* bad luck; use full step */
1663c92abb8aSShri Abhyankar       if (vi->lsmonitor) {
1664c92abb8aSShri Abhyankar         ierr = PetscViewerASCIIMonitorPrintf(vi->lsmonitor,"Line search: Unable to find good step length! %D \n",count);CHKERRQ(ierr);
1665c92abb8aSShri 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);
16662b4ed282SShri Abhyankar       }
16672b4ed282SShri Abhyankar       ierr = VecCopy(x,w);CHKERRQ(ierr);
16682b4ed282SShri Abhyankar       *flag = PETSC_FALSE;
16692b4ed282SShri Abhyankar       break;
16702b4ed282SShri Abhyankar     }
16712b4ed282SShri Abhyankar     lambdatemp = -initslope/((*gnorm)*(*gnorm) - fnorm*fnorm - 2.0*initslope);
16722b4ed282SShri Abhyankar     if (lambdatemp > .5*lambda)  lambdatemp = .5*lambda;
16732b4ed282SShri Abhyankar     if (lambdatemp <= .1*lambda) lambda     = .1*lambda;
16742b4ed282SShri Abhyankar     else                         lambda     = lambdatemp;
16752b4ed282SShri Abhyankar 
16762b4ed282SShri Abhyankar     ierr = VecWAXPY(w,-lambda,y,x);CHKERRQ(ierr);
16772b4ed282SShri Abhyankar     if (snes->nfuncs >= snes->max_funcs) {
16782b4ed282SShri Abhyankar       ierr  = PetscInfo1(snes,"Exceeded maximum function evaluations, while looking for good step length! %D \n",count);CHKERRQ(ierr);
16792b4ed282SShri 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);
16802b4ed282SShri Abhyankar       *flag = PETSC_FALSE;
16812b4ed282SShri Abhyankar       snes->reason = SNES_DIVERGED_FUNCTION_COUNT;
16822b4ed282SShri Abhyankar       break;
16832b4ed282SShri Abhyankar     }
16842b4ed282SShri Abhyankar     ierr = SNESComputeFunction(snes,w,g);CHKERRQ(ierr);
16852b4ed282SShri Abhyankar     if (snes->domainerror) {
16862b4ed282SShri Abhyankar       ierr = PetscLogEventEnd(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr);
16872b4ed282SShri Abhyankar       PetscFunctionReturn(0);
16882b4ed282SShri Abhyankar     }
16892b4ed282SShri Abhyankar     ierr = VecNorm(g,NORM_2,gnorm);CHKERRQ(ierr);
16902b4ed282SShri Abhyankar     if PetscIsInfOrNanReal(*gnorm) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FP,"User provided compute function generated a Not-a-Number");
16912b4ed282SShri Abhyankar     if (.5*(*gnorm)*(*gnorm) < .5*fnorm*fnorm + lambda*vi->alpha*initslope) { /* sufficient reduction */
1692c92abb8aSShri Abhyankar       if (vi->lsmonitor) {
1693c92abb8aSShri Abhyankar         ierr = PetscViewerASCIIMonitorPrintf(vi->lsmonitor,"    Line Search: Quadratically determined step, lambda=%G\n",lambda);CHKERRQ(ierr);
16942b4ed282SShri Abhyankar       }
16952b4ed282SShri Abhyankar       break;
16962b4ed282SShri Abhyankar     }
16972b4ed282SShri Abhyankar     count++;
16982b4ed282SShri Abhyankar   }
16992b4ed282SShri Abhyankar   theend2:
17002b4ed282SShri Abhyankar   /* Optional user-defined check for line search step validity */
17012b4ed282SShri Abhyankar   if (vi->postcheckstep) {
17022b4ed282SShri Abhyankar     ierr = (*vi->postcheckstep)(snes,x,y,w,vi->postcheck,&changed_y,&changed_w);CHKERRQ(ierr);
17032b4ed282SShri Abhyankar     if (changed_y) {
17042b4ed282SShri Abhyankar       ierr = VecWAXPY(w,-1.0,y,x);CHKERRQ(ierr);
17052b4ed282SShri Abhyankar     }
17062b4ed282SShri Abhyankar     if (changed_y || changed_w) { /* recompute the function if the step has changed */
17072b4ed282SShri Abhyankar       ierr = SNESComputeFunction(snes,w,g);
17082b4ed282SShri Abhyankar       if (snes->domainerror) {
17092b4ed282SShri Abhyankar         ierr = PetscLogEventEnd(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr);
17102b4ed282SShri Abhyankar         PetscFunctionReturn(0);
17112b4ed282SShri Abhyankar       }
17122b4ed282SShri Abhyankar       ierr = VecNormBegin(g,NORM_2,gnorm);CHKERRQ(ierr);
17132b4ed282SShri Abhyankar       ierr = VecNormBegin(y,NORM_2,ynorm);CHKERRQ(ierr);
17142b4ed282SShri Abhyankar       ierr = VecNormEnd(g,NORM_2,gnorm);CHKERRQ(ierr);
17152b4ed282SShri Abhyankar       ierr = VecNormEnd(y,NORM_2,ynorm);CHKERRQ(ierr);
17162b4ed282SShri Abhyankar       if PetscIsInfOrNanReal(*gnorm) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FP,"User provided compute function generated a Not-a-Number");
17172b4ed282SShri Abhyankar     }
17182b4ed282SShri Abhyankar   }
17192b4ed282SShri Abhyankar   ierr = PetscLogEventEnd(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr);
17202b4ed282SShri Abhyankar   PetscFunctionReturn(0);
17212b4ed282SShri Abhyankar }
17222b4ed282SShri Abhyankar 
1723ace3abfcSBarry 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*/
17242b4ed282SShri Abhyankar /* -------------------------------------------------------------------------- */
17252b4ed282SShri Abhyankar EXTERN_C_BEGIN
17262b4ed282SShri Abhyankar #undef __FUNCT__
17272b4ed282SShri Abhyankar #define __FUNCT__ "SNESLineSearchSet_VI"
17282b4ed282SShri Abhyankar PetscErrorCode PETSCSNES_DLLEXPORT SNESLineSearchSet_VI(SNES snes,FCN2 func,void *lsctx)
17292b4ed282SShri Abhyankar {
17302b4ed282SShri Abhyankar   PetscFunctionBegin;
17312b4ed282SShri Abhyankar   ((SNES_VI *)(snes->data))->LineSearch = func;
17322b4ed282SShri Abhyankar   ((SNES_VI *)(snes->data))->lsP        = lsctx;
17332b4ed282SShri Abhyankar   PetscFunctionReturn(0);
17342b4ed282SShri Abhyankar }
17352b4ed282SShri Abhyankar EXTERN_C_END
17362b4ed282SShri Abhyankar 
17372b4ed282SShri Abhyankar /* -------------------------------------------------------------------------- */
17382b4ed282SShri Abhyankar EXTERN_C_BEGIN
17392b4ed282SShri Abhyankar #undef __FUNCT__
17402b4ed282SShri Abhyankar #define __FUNCT__ "SNESLineSearchSetMonitor_VI"
1741ace3abfcSBarry Smith PetscErrorCode PETSCSNES_DLLEXPORT SNESLineSearchSetMonitor_VI(SNES snes,PetscBool flg)
17422b4ed282SShri Abhyankar {
17432b4ed282SShri Abhyankar   SNES_VI        *vi = (SNES_VI*)snes->data;
17442b4ed282SShri Abhyankar   PetscErrorCode ierr;
17452b4ed282SShri Abhyankar 
17462b4ed282SShri Abhyankar   PetscFunctionBegin;
1747c92abb8aSShri Abhyankar   if (flg && !vi->lsmonitor) {
1748c92abb8aSShri Abhyankar     ierr = PetscViewerASCIIMonitorCreate(((PetscObject)snes)->comm,"stdout",((PetscObject)snes)->tablevel,&vi->lsmonitor);CHKERRQ(ierr);
1749c92abb8aSShri Abhyankar   } else if (!flg && vi->lsmonitor) {
1750c92abb8aSShri Abhyankar     ierr = PetscViewerASCIIMonitorDestroy(vi->lsmonitor);CHKERRQ(ierr);
17512b4ed282SShri Abhyankar   }
17522b4ed282SShri Abhyankar   PetscFunctionReturn(0);
17532b4ed282SShri Abhyankar }
17542b4ed282SShri Abhyankar EXTERN_C_END
17552b4ed282SShri Abhyankar 
17562b4ed282SShri Abhyankar /*
17572b4ed282SShri Abhyankar    SNESView_VI - Prints info from the SNESVI data structure.
17582b4ed282SShri Abhyankar 
17592b4ed282SShri Abhyankar    Input Parameters:
17602b4ed282SShri Abhyankar .  SNES - the SNES context
17612b4ed282SShri Abhyankar .  viewer - visualization context
17622b4ed282SShri Abhyankar 
17632b4ed282SShri Abhyankar    Application Interface Routine: SNESView()
17642b4ed282SShri Abhyankar */
17652b4ed282SShri Abhyankar #undef __FUNCT__
17662b4ed282SShri Abhyankar #define __FUNCT__ "SNESView_VI"
17672b4ed282SShri Abhyankar static PetscErrorCode SNESView_VI(SNES snes,PetscViewer viewer)
17682b4ed282SShri Abhyankar {
17692b4ed282SShri Abhyankar   SNES_VI        *vi = (SNES_VI *)snes->data;
177078c4b9d3SShri Abhyankar   const char     *cstr,*tstr;
17712b4ed282SShri Abhyankar   PetscErrorCode ierr;
1772ace3abfcSBarry Smith   PetscBool     iascii;
17732b4ed282SShri Abhyankar 
17742b4ed282SShri Abhyankar   PetscFunctionBegin;
17752b4ed282SShri Abhyankar   ierr = PetscTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
17762b4ed282SShri Abhyankar   if (iascii) {
17772b4ed282SShri Abhyankar     if (vi->LineSearch == SNESLineSearchNo_VI)             cstr = "SNESLineSearchNo";
17782b4ed282SShri Abhyankar     else if (vi->LineSearch == SNESLineSearchQuadratic_VI) cstr = "SNESLineSearchQuadratic";
17792b4ed282SShri Abhyankar     else if (vi->LineSearch == SNESLineSearchCubic_VI)     cstr = "SNESLineSearchCubic";
17802b4ed282SShri Abhyankar     else                                                cstr = "unknown";
178178c4b9d3SShri Abhyankar     if (snes->ops->solve == SNESSolveVI_SS)      tstr = "Semismooth";
178278c4b9d3SShri Abhyankar     else if (snes->ops->solve == SNESSolveVI_AS)  tstr = "Active Set";
1783*0a7c7af0SShri Abhyankar     else if (snes->ops->solve == SNESSolveVI_RS) tstr = "Reduced Space";
178478c4b9d3SShri Abhyankar     else                                         tstr = "unknown";
178578c4b9d3SShri Abhyankar     ierr = PetscViewerASCIIPrintf(viewer,"  VI algorithm: %s\n",tstr);CHKERRQ(ierr);
17862b4ed282SShri Abhyankar     ierr = PetscViewerASCIIPrintf(viewer,"  line search variant: %s\n",cstr);CHKERRQ(ierr);
17872b4ed282SShri Abhyankar     ierr = PetscViewerASCIIPrintf(viewer,"  alpha=%G, maxstep=%G, minlambda=%G\n",vi->alpha,vi->maxstep,vi->minlambda);CHKERRQ(ierr);
17882b4ed282SShri Abhyankar   } else {
17892b4ed282SShri Abhyankar     SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Viewer type %s not supported for SNES EQ VI",((PetscObject)viewer)->type_name);
17902b4ed282SShri Abhyankar   }
17912b4ed282SShri Abhyankar   PetscFunctionReturn(0);
17922b4ed282SShri Abhyankar }
17932b4ed282SShri Abhyankar 
17942b4ed282SShri Abhyankar /*
17952b4ed282SShri Abhyankar    SNESVISetVariableBounds - Sets the lower and upper bounds for the solution vector. xl <= x <= xu.
17962b4ed282SShri Abhyankar 
17972b4ed282SShri Abhyankar    Input Parameters:
17982b4ed282SShri Abhyankar .  snes - the SNES context.
17992b4ed282SShri Abhyankar .  xl   - lower bound.
18002b4ed282SShri Abhyankar .  xu   - upper bound.
18012b4ed282SShri Abhyankar 
18022b4ed282SShri Abhyankar    Notes:
18032b4ed282SShri Abhyankar    If this routine is not called then the lower and upper bounds are set to
180484c105d7SBarry Smith    PETSC_VI_INF and PETSC_VI_NINF respectively during SNESSetUp().
180584c105d7SBarry Smith 
18062b4ed282SShri Abhyankar */
18072b4ed282SShri Abhyankar 
18082b4ed282SShri Abhyankar #undef __FUNCT__
18092b4ed282SShri Abhyankar #define __FUNCT__ "SNESVISetVariableBounds"
181069c03620SShri Abhyankar PetscErrorCode SNESVISetVariableBounds(SNES snes, Vec xl, Vec xu)
18112b4ed282SShri Abhyankar {
18122b4ed282SShri Abhyankar   SNES_VI        *vi = (SNES_VI*)snes->data;
18132b4ed282SShri Abhyankar 
18142b4ed282SShri Abhyankar   PetscFunctionBegin;
18152b4ed282SShri Abhyankar   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
18162b4ed282SShri Abhyankar   PetscValidHeaderSpecific(xl,VEC_CLASSID,2);
18172b4ed282SShri Abhyankar   PetscValidHeaderSpecific(xu,VEC_CLASSID,3);
18182b4ed282SShri Abhyankar 
18192b4ed282SShri Abhyankar   /* Check if SNESSetFunction is called */
18202b4ed282SShri Abhyankar   if(!snes->vec_func) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call SNESSetFunction() first");
18212b4ed282SShri Abhyankar 
18222b4ed282SShri Abhyankar   /* Check if the vector sizes are compatible for lower and upper bounds */
18232b4ed282SShri 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);
18242b4ed282SShri 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);
18252b4ed282SShri Abhyankar   vi->usersetxbounds = PETSC_TRUE;
18262b4ed282SShri Abhyankar   vi->xl = xl;
18272b4ed282SShri Abhyankar   vi->xu = xu;
18282b4ed282SShri Abhyankar 
18292b4ed282SShri Abhyankar   PetscFunctionReturn(0);
18302b4ed282SShri Abhyankar }
18312b4ed282SShri Abhyankar /* -------------------------------------------------------------------------- */
18322b4ed282SShri Abhyankar /*
18332b4ed282SShri Abhyankar    SNESSetFromOptions_VI - Sets various parameters for the SNESVI method.
18342b4ed282SShri Abhyankar 
18352b4ed282SShri Abhyankar    Input Parameter:
18362b4ed282SShri Abhyankar .  snes - the SNES context
18372b4ed282SShri Abhyankar 
18382b4ed282SShri Abhyankar    Application Interface Routine: SNESSetFromOptions()
18392b4ed282SShri Abhyankar */
18402b4ed282SShri Abhyankar #undef __FUNCT__
18412b4ed282SShri Abhyankar #define __FUNCT__ "SNESSetFromOptions_VI"
18422b4ed282SShri Abhyankar static PetscErrorCode SNESSetFromOptions_VI(SNES snes)
18432b4ed282SShri Abhyankar {
18442b4ed282SShri Abhyankar   SNES_VI        *vi = (SNES_VI *)snes->data;
18452b4ed282SShri Abhyankar   const char     *lses[] = {"basic","basicnonorms","quadratic","cubic"};
1846d950fb63SShri Abhyankar   const char     *vies[] = {"ss","as","rs"};
18472b4ed282SShri Abhyankar   PetscErrorCode ierr;
18482b4ed282SShri Abhyankar   PetscInt       indx;
184969c03620SShri Abhyankar   PetscBool     flg,set,flg2;
18502b4ed282SShri Abhyankar 
18512b4ed282SShri Abhyankar   PetscFunctionBegin;
18522b4ed282SShri Abhyankar     ierr = PetscOptionsHead("SNES semismooth method options");CHKERRQ(ierr);
18532b4ed282SShri Abhyankar     ierr = PetscOptionsReal("-snes_vi_alpha","Function norm must decrease by","None",vi->alpha,&vi->alpha,0);CHKERRQ(ierr);
18542b4ed282SShri Abhyankar     ierr = PetscOptionsReal("-snes_vi_maxstep","Step must be less than","None",vi->maxstep,&vi->maxstep,0);CHKERRQ(ierr);
18552b4ed282SShri Abhyankar     ierr = PetscOptionsReal("-snes_vi_minlambda","Minimum lambda allowed","None",vi->minlambda,&vi->minlambda,0);CHKERRQ(ierr);
18562b4ed282SShri Abhyankar     ierr = PetscOptionsReal("-snes_vi_const_tol","constraint tolerance","None",vi->const_tol,&vi->const_tol,0);CHKERRQ(ierr);
1857acfcf0e5SJed Brown     ierr = PetscOptionsBool("-snes_vi_lsmonitor","Print progress of line searches","SNESLineSearchSetMonitor",vi->lsmonitor ? PETSC_TRUE : PETSC_FALSE,&flg,&set);CHKERRQ(ierr);
18582b4ed282SShri Abhyankar     if (set) {ierr = SNESLineSearchSetMonitor(snes,flg);CHKERRQ(ierr);}
1859d950fb63SShri Abhyankar     ierr = PetscOptionsEList("-snes_vi_type","Semismooth algorithm used","",vies,3,"ss",&indx,&flg2);CHKERRQ(ierr);
186069c03620SShri Abhyankar     if (flg2) {
186169c03620SShri Abhyankar       switch (indx) {
186269c03620SShri Abhyankar       case 0:
186369c03620SShri Abhyankar 	snes->ops->solve = SNESSolveVI_SS;
186469c03620SShri Abhyankar 	break;
186569c03620SShri Abhyankar       case 1:
186669c03620SShri Abhyankar 	snes->ops->solve = SNESSolveVI_AS;
186769c03620SShri Abhyankar 	break;
1868d950fb63SShri Abhyankar       case 2:
1869d950fb63SShri Abhyankar         snes->ops->solve = SNESSolveVI_RS;
1870d950fb63SShri Abhyankar         break;
187169c03620SShri Abhyankar       }
187269c03620SShri Abhyankar     }
1873c92abb8aSShri Abhyankar     ierr = PetscOptionsEList("-snes_vi_ls","Line search used","SNESLineSearchSet",lses,4,"cubic",&indx,&flg);CHKERRQ(ierr);
18742b4ed282SShri Abhyankar     if (flg) {
18752b4ed282SShri Abhyankar       switch (indx) {
18762b4ed282SShri Abhyankar       case 0:
18772b4ed282SShri Abhyankar         ierr = SNESLineSearchSet(snes,SNESLineSearchNo_VI,PETSC_NULL);CHKERRQ(ierr);
18782b4ed282SShri Abhyankar         break;
18792b4ed282SShri Abhyankar       case 1:
18802b4ed282SShri Abhyankar         ierr = SNESLineSearchSet(snes,SNESLineSearchNoNorms_VI,PETSC_NULL);CHKERRQ(ierr);
18812b4ed282SShri Abhyankar         break;
18822b4ed282SShri Abhyankar       case 2:
18832b4ed282SShri Abhyankar         ierr = SNESLineSearchSet(snes,SNESLineSearchQuadratic_VI,PETSC_NULL);CHKERRQ(ierr);
18842b4ed282SShri Abhyankar         break;
18852b4ed282SShri Abhyankar       case 3:
18862b4ed282SShri Abhyankar         ierr = SNESLineSearchSet(snes,SNESLineSearchCubic_VI,PETSC_NULL);CHKERRQ(ierr);
18872b4ed282SShri Abhyankar         break;
18882b4ed282SShri Abhyankar       }
18892b4ed282SShri Abhyankar     }
18902b4ed282SShri Abhyankar   ierr = PetscOptionsTail();CHKERRQ(ierr);
18912b4ed282SShri Abhyankar   PetscFunctionReturn(0);
18922b4ed282SShri Abhyankar }
18932b4ed282SShri Abhyankar /* -------------------------------------------------------------------------- */
18942b4ed282SShri Abhyankar /*MC
18952b4ed282SShri Abhyankar       SNESVI - Semismooth newton method based nonlinear solver that uses a line search
18962b4ed282SShri Abhyankar 
18972b4ed282SShri Abhyankar    Options Database:
18982b4ed282SShri Abhyankar +   -snes_vi [cubic,quadratic,basic,basicnonorms] - Selects line search
18992b4ed282SShri Abhyankar .   -snes_vi_alpha <alpha> - Sets alpha
19002b4ed282SShri 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)
19012b4ed282SShri Abhyankar .   -snes_vi_minlambda <minlambda>  - Sets the minimum lambda the line search will use  minlambda / max_i ( y[i]/x[i] )
19022b4ed282SShri Abhyankar -   -snes_vi_monitor - print information about progress of line searches
19032b4ed282SShri Abhyankar 
19042b4ed282SShri Abhyankar 
19052b4ed282SShri Abhyankar    Level: beginner
19062b4ed282SShri Abhyankar 
19072b4ed282SShri Abhyankar .seealso:  SNESCreate(), SNES, SNESSetType(), SNESTR, SNESLineSearchSet(),
19082b4ed282SShri Abhyankar            SNESLineSearchSetPostCheck(), SNESLineSearchNo(), SNESLineSearchCubic(), SNESLineSearchQuadratic(),
19092b4ed282SShri Abhyankar            SNESLineSearchSet(), SNESLineSearchNoNorms(), SNESLineSearchSetPreCheck(), SNESLineSearchSetParams(), SNESLineSearchGetParams()
19102b4ed282SShri Abhyankar 
19112b4ed282SShri Abhyankar M*/
19122b4ed282SShri Abhyankar EXTERN_C_BEGIN
19132b4ed282SShri Abhyankar #undef __FUNCT__
19142b4ed282SShri Abhyankar #define __FUNCT__ "SNESCreate_VI"
19152b4ed282SShri Abhyankar PetscErrorCode PETSCSNES_DLLEXPORT SNESCreate_VI(SNES snes)
19162b4ed282SShri Abhyankar {
19172b4ed282SShri Abhyankar   PetscErrorCode ierr;
19182b4ed282SShri Abhyankar   SNES_VI      *vi;
19192b4ed282SShri Abhyankar 
19202b4ed282SShri Abhyankar   PetscFunctionBegin;
19212b4ed282SShri Abhyankar   snes->ops->setup	     = SNESSetUp_VI;
192269c03620SShri Abhyankar   snes->ops->solve	     = SNESSolveVI_SS;
19232b4ed282SShri Abhyankar   snes->ops->destroy	     = SNESDestroy_VI;
19242b4ed282SShri Abhyankar   snes->ops->setfromoptions  = SNESSetFromOptions_VI;
19252b4ed282SShri Abhyankar   snes->ops->view            = SNESView_VI;
19262b4ed282SShri Abhyankar   snes->ops->converged       = SNESDefaultConverged_VI;
19272b4ed282SShri Abhyankar 
19282b4ed282SShri Abhyankar   ierr                   = PetscNewLog(snes,SNES_VI,&vi);CHKERRQ(ierr);
19292b4ed282SShri Abhyankar   snes->data    	 = (void*)vi;
19302b4ed282SShri Abhyankar   vi->alpha		 = 1.e-4;
19312b4ed282SShri Abhyankar   vi->maxstep		 = 1.e8;
19322b4ed282SShri Abhyankar   vi->minlambda         = 1.e-12;
19332b4ed282SShri Abhyankar   vi->LineSearch        = SNESLineSearchCubic_VI;
19342b4ed282SShri Abhyankar   vi->lsP               = PETSC_NULL;
19352b4ed282SShri Abhyankar   vi->postcheckstep     = PETSC_NULL;
19362b4ed282SShri Abhyankar   vi->postcheck         = PETSC_NULL;
19372b4ed282SShri Abhyankar   vi->precheckstep      = PETSC_NULL;
19382b4ed282SShri Abhyankar   vi->precheck          = PETSC_NULL;
19392b4ed282SShri Abhyankar   vi->const_tol         =  2.2204460492503131e-16;
19402b4ed282SShri Abhyankar   vi->computessfunction = ComputeFischerFunction;
19412b4ed282SShri Abhyankar 
19422b4ed282SShri Abhyankar   ierr = PetscObjectComposeFunctionDynamic((PetscObject)snes,"SNESLineSearchSetMonitor_C","SNESLineSearchSetMonitor_VI",SNESLineSearchSetMonitor_VI);CHKERRQ(ierr);
19432b4ed282SShri Abhyankar   ierr = PetscObjectComposeFunctionDynamic((PetscObject)snes,"SNESLineSearchSet_C","SNESLineSearchSet_VI",SNESLineSearchSet_VI);CHKERRQ(ierr);
19442b4ed282SShri Abhyankar 
19452b4ed282SShri Abhyankar   PetscFunctionReturn(0);
19462b4ed282SShri Abhyankar }
19472b4ed282SShri Abhyankar EXTERN_C_END
1948