xref: /petsc/src/snes/impls/vi/vi.c (revision c1a5e5210aaf464d5eeb75cc7d509f6fc951d696)
12b4ed282SShri Abhyankar #define PETSCSNES_DLL
22b4ed282SShri Abhyankar 
32b4ed282SShri Abhyankar #include "../src/snes/impls/vi/viimpl.h"
4408da460SShri Abhyankar #include "../include/private/kspimpl.h"
52b4ed282SShri Abhyankar 
69308c137SBarry Smith #undef __FUNCT__
79308c137SBarry Smith #define __FUNCT__ "SNESMonitorVI"
87087cfbeSBarry Smith PetscErrorCode  SNESMonitorVI(SNES snes,PetscInt its,PetscReal fgnorm,void *dummy)
99308c137SBarry Smith {
109308c137SBarry Smith   PetscErrorCode          ierr;
119308c137SBarry Smith   SNES_VI                 *vi = (SNES_VI*)snes->data;
129308c137SBarry Smith   PetscViewerASCIIMonitor viewer = (PetscViewerASCIIMonitor) dummy;
139308c137SBarry Smith   const PetscScalar       *x,*xl,*xu,*f;
1409573ac7SBarry Smith   PetscInt                i,n,act = 0;
159308c137SBarry Smith   PetscReal               rnorm,fnorm;
169308c137SBarry Smith 
179308c137SBarry Smith   PetscFunctionBegin;
189308c137SBarry Smith   if (!dummy) {
199308c137SBarry Smith     ierr = PetscViewerASCIIMonitorCreate(((PetscObject)snes)->comm,"stdout",0,&viewer);CHKERRQ(ierr);
209308c137SBarry Smith   }
219308c137SBarry Smith   ierr = VecGetLocalSize(snes->vec_sol,&n);CHKERRQ(ierr);
229308c137SBarry Smith   ierr = VecGetArrayRead(vi->xl,&xl);CHKERRQ(ierr);
239308c137SBarry Smith   ierr = VecGetArrayRead(vi->xu,&xu);CHKERRQ(ierr);
249308c137SBarry Smith   ierr = VecGetArrayRead(snes->vec_sol,&x);CHKERRQ(ierr);
253f731af5SBarry Smith   ierr = VecGetArrayRead(snes->vec_func,&f);CHKERRQ(ierr);
269308c137SBarry Smith 
279308c137SBarry Smith   rnorm = 0.0;
289308c137SBarry Smith   for (i=0; i<n; i++) {
297b2c10efSShri Abhyankar     if (((x[i] > xl[i] + 1.e-8 || (f[i] < 0.0)) && ((x[i] < xu[i] - 1.e-8) || f[i] > 0.0))) rnorm += f[i]*f[i];
3009573ac7SBarry Smith     else act++;
319308c137SBarry Smith   }
323f731af5SBarry Smith   ierr = VecRestoreArrayRead(snes->vec_func,&f);CHKERRQ(ierr);
339308c137SBarry Smith   ierr = VecRestoreArrayRead(vi->xl,&xl);CHKERRQ(ierr);
349308c137SBarry Smith   ierr = VecRestoreArrayRead(vi->xu,&xu);CHKERRQ(ierr);
359308c137SBarry Smith   ierr = VecRestoreArrayRead(snes->vec_sol,&x);CHKERRQ(ierr);
369308c137SBarry Smith   ierr = MPI_Allreduce(&rnorm,&fnorm,1,MPIU_REAL,MPI_SUM,((PetscObject)snes)->comm);CHKERRQ(ierr);
379308c137SBarry Smith   fnorm = sqrt(fnorm);
3809573ac7SBarry Smith   ierr = PetscViewerASCIIMonitorPrintf(viewer,"%3D SNES VI Function norm %14.12e Active constraints %D\n",its,fnorm,act);CHKERRQ(ierr);
399308c137SBarry Smith   if (!dummy) {
409308c137SBarry Smith     ierr = PetscViewerASCIIMonitorDestroy(viewer);CHKERRQ(ierr);
419308c137SBarry Smith   }
429308c137SBarry Smith   PetscFunctionReturn(0);
439308c137SBarry Smith }
449308c137SBarry Smith 
452b4ed282SShri Abhyankar /*
462b4ed282SShri Abhyankar      Checks if J^T F = 0 which implies we've found a local minimum of the norm of the function,
472b4ed282SShri Abhyankar     || F(u) ||_2 but not a zero, F(u) = 0. In the case when one cannot compute J^T F we use the fact that
482b4ed282SShri Abhyankar     0 = (J^T F)^T W = F^T J W iff W not in the null space of J. Thanks for Jorge More
492b4ed282SShri Abhyankar     for this trick. One assumes that the probability that W is in the null space of J is very, very small.
502b4ed282SShri Abhyankar */
512b4ed282SShri Abhyankar #undef __FUNCT__
522b4ed282SShri Abhyankar #define __FUNCT__ "SNESVICheckLocalMin_Private"
53ace3abfcSBarry Smith PetscErrorCode SNESVICheckLocalMin_Private(SNES snes,Mat A,Vec F,Vec W,PetscReal fnorm,PetscBool *ismin)
542b4ed282SShri Abhyankar {
552b4ed282SShri Abhyankar   PetscReal      a1;
562b4ed282SShri Abhyankar   PetscErrorCode ierr;
57ace3abfcSBarry Smith   PetscBool     hastranspose;
582b4ed282SShri Abhyankar 
592b4ed282SShri Abhyankar   PetscFunctionBegin;
602b4ed282SShri Abhyankar   *ismin = PETSC_FALSE;
612b4ed282SShri Abhyankar   ierr = MatHasOperation(A,MATOP_MULT_TRANSPOSE,&hastranspose);CHKERRQ(ierr);
622b4ed282SShri Abhyankar   if (hastranspose) {
632b4ed282SShri Abhyankar     /* Compute || J^T F|| */
642b4ed282SShri Abhyankar     ierr = MatMultTranspose(A,F,W);CHKERRQ(ierr);
652b4ed282SShri Abhyankar     ierr = VecNorm(W,NORM_2,&a1);CHKERRQ(ierr);
662b4ed282SShri Abhyankar     ierr = PetscInfo1(snes,"|| J^T F|| %G near zero implies found a local minimum\n",a1/fnorm);CHKERRQ(ierr);
672b4ed282SShri Abhyankar     if (a1/fnorm < 1.e-4) *ismin = PETSC_TRUE;
682b4ed282SShri Abhyankar   } else {
692b4ed282SShri Abhyankar     Vec         work;
702b4ed282SShri Abhyankar     PetscScalar result;
712b4ed282SShri Abhyankar     PetscReal   wnorm;
722b4ed282SShri Abhyankar 
732b4ed282SShri Abhyankar     ierr = VecSetRandom(W,PETSC_NULL);CHKERRQ(ierr);
742b4ed282SShri Abhyankar     ierr = VecNorm(W,NORM_2,&wnorm);CHKERRQ(ierr);
752b4ed282SShri Abhyankar     ierr = VecDuplicate(W,&work);CHKERRQ(ierr);
762b4ed282SShri Abhyankar     ierr = MatMult(A,W,work);CHKERRQ(ierr);
772b4ed282SShri Abhyankar     ierr = VecDot(F,work,&result);CHKERRQ(ierr);
782b4ed282SShri Abhyankar     ierr = VecDestroy(work);CHKERRQ(ierr);
792b4ed282SShri Abhyankar     a1   = PetscAbsScalar(result)/(fnorm*wnorm);
802b4ed282SShri Abhyankar     ierr = PetscInfo1(snes,"(F^T J random)/(|| F ||*||random|| %G near zero implies found a local minimum\n",a1);CHKERRQ(ierr);
812b4ed282SShri Abhyankar     if (a1 < 1.e-4) *ismin = PETSC_TRUE;
822b4ed282SShri Abhyankar   }
832b4ed282SShri Abhyankar   PetscFunctionReturn(0);
842b4ed282SShri Abhyankar }
852b4ed282SShri Abhyankar 
862b4ed282SShri Abhyankar /*
872b4ed282SShri Abhyankar      Checks if J^T(F - J*X) = 0
882b4ed282SShri Abhyankar */
892b4ed282SShri Abhyankar #undef __FUNCT__
902b4ed282SShri Abhyankar #define __FUNCT__ "SNESVICheckResidual_Private"
912b4ed282SShri Abhyankar PetscErrorCode SNESVICheckResidual_Private(SNES snes,Mat A,Vec F,Vec X,Vec W1,Vec W2)
922b4ed282SShri Abhyankar {
932b4ed282SShri Abhyankar   PetscReal      a1,a2;
942b4ed282SShri Abhyankar   PetscErrorCode ierr;
95ace3abfcSBarry Smith   PetscBool     hastranspose;
962b4ed282SShri Abhyankar 
972b4ed282SShri Abhyankar   PetscFunctionBegin;
982b4ed282SShri Abhyankar   ierr = MatHasOperation(A,MATOP_MULT_TRANSPOSE,&hastranspose);CHKERRQ(ierr);
992b4ed282SShri Abhyankar   if (hastranspose) {
1002b4ed282SShri Abhyankar     ierr = MatMult(A,X,W1);CHKERRQ(ierr);
1012b4ed282SShri Abhyankar     ierr = VecAXPY(W1,-1.0,F);CHKERRQ(ierr);
1022b4ed282SShri Abhyankar 
1032b4ed282SShri Abhyankar     /* Compute || J^T W|| */
1042b4ed282SShri Abhyankar     ierr = MatMultTranspose(A,W1,W2);CHKERRQ(ierr);
1052b4ed282SShri Abhyankar     ierr = VecNorm(W1,NORM_2,&a1);CHKERRQ(ierr);
1062b4ed282SShri Abhyankar     ierr = VecNorm(W2,NORM_2,&a2);CHKERRQ(ierr);
1072b4ed282SShri Abhyankar     if (a1 != 0.0) {
1082b4ed282SShri Abhyankar       ierr = PetscInfo1(snes,"||J^T(F-Ax)||/||F-AX|| %G near zero implies inconsistent rhs\n",a2/a1);CHKERRQ(ierr);
1092b4ed282SShri Abhyankar     }
1102b4ed282SShri Abhyankar   }
1112b4ed282SShri Abhyankar   PetscFunctionReturn(0);
1122b4ed282SShri Abhyankar }
1132b4ed282SShri Abhyankar 
1142b4ed282SShri Abhyankar /*
1152b4ed282SShri Abhyankar   SNESDefaultConverged_VI - Checks the convergence of the semismooth newton algorithm.
1162b4ed282SShri Abhyankar 
1172b4ed282SShri Abhyankar   Notes:
1182b4ed282SShri Abhyankar   The convergence criterion currently implemented is
1192b4ed282SShri Abhyankar   merit < abstol
1202b4ed282SShri Abhyankar   merit < rtol*merit_initial
1212b4ed282SShri Abhyankar */
1222b4ed282SShri Abhyankar #undef __FUNCT__
1232b4ed282SShri Abhyankar #define __FUNCT__ "SNESDefaultConverged_VI"
1242b4ed282SShri Abhyankar PetscErrorCode SNESDefaultConverged_VI(SNES snes,PetscInt it,PetscReal xnorm,PetscReal gradnorm,PetscReal merit,SNESConvergedReason *reason,void *dummy)
1252b4ed282SShri Abhyankar {
1262b4ed282SShri Abhyankar   PetscErrorCode ierr;
1272b4ed282SShri Abhyankar 
1282b4ed282SShri Abhyankar   PetscFunctionBegin;
1292b4ed282SShri Abhyankar   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
1302b4ed282SShri Abhyankar   PetscValidPointer(reason,6);
1312b4ed282SShri Abhyankar 
1322b4ed282SShri Abhyankar   *reason = SNES_CONVERGED_ITERATING;
1332b4ed282SShri Abhyankar 
1342b4ed282SShri Abhyankar   if (!it) {
1352b4ed282SShri Abhyankar     /* set parameter for default relative tolerance convergence test */
1362b4ed282SShri Abhyankar     snes->ttol = merit*snes->rtol;
1372b4ed282SShri Abhyankar   }
1382b4ed282SShri Abhyankar   if (merit != merit) {
1392b4ed282SShri Abhyankar     ierr = PetscInfo(snes,"Failed to converged, function norm is NaN\n");CHKERRQ(ierr);
1402b4ed282SShri Abhyankar     *reason = SNES_DIVERGED_FNORM_NAN;
1412b4ed282SShri Abhyankar   } else if (merit < snes->abstol) {
1422b4ed282SShri Abhyankar     ierr = PetscInfo2(snes,"Converged due to merit function %G < %G\n",merit,snes->abstol);CHKERRQ(ierr);
1432b4ed282SShri Abhyankar     *reason = SNES_CONVERGED_FNORM_ABS;
1442b4ed282SShri Abhyankar   } else if (snes->nfuncs >= snes->max_funcs) {
1452b4ed282SShri Abhyankar     ierr = PetscInfo2(snes,"Exceeded maximum number of function evaluations: %D > %D\n",snes->nfuncs,snes->max_funcs);CHKERRQ(ierr);
1462b4ed282SShri Abhyankar     *reason = SNES_DIVERGED_FUNCTION_COUNT;
1472b4ed282SShri Abhyankar   }
1482b4ed282SShri Abhyankar 
1492b4ed282SShri Abhyankar   if (it && !*reason) {
1502b4ed282SShri Abhyankar     if (merit < snes->ttol) {
1512b4ed282SShri Abhyankar       ierr = PetscInfo2(snes,"Converged due to merit function %G < %G (relative tolerance)\n",merit,snes->ttol);CHKERRQ(ierr);
1522b4ed282SShri Abhyankar       *reason = SNES_CONVERGED_FNORM_RELATIVE;
1532b4ed282SShri Abhyankar     }
1542b4ed282SShri Abhyankar   }
1552b4ed282SShri Abhyankar   PetscFunctionReturn(0);
1562b4ed282SShri Abhyankar }
1572b4ed282SShri Abhyankar 
1582b4ed282SShri Abhyankar /*
1592b4ed282SShri Abhyankar   SNESVIComputeMeritFunction - Evaluates the merit function for the mixed complementarity problem.
1602b4ed282SShri Abhyankar 
1612b4ed282SShri Abhyankar   Input Parameter:
1622b4ed282SShri Abhyankar . phi - the semismooth function
1632b4ed282SShri Abhyankar 
1642b4ed282SShri Abhyankar   Output Parameter:
1652b4ed282SShri Abhyankar . merit - the merit function
1662b4ed282SShri Abhyankar . phinorm - ||phi||
1672b4ed282SShri Abhyankar 
1682b4ed282SShri Abhyankar   Notes:
1692b4ed282SShri Abhyankar   The merit function for the mixed complementarity problem is defined as
1702b4ed282SShri Abhyankar      merit = 0.5*phi^T*phi
1712b4ed282SShri Abhyankar */
1722b4ed282SShri Abhyankar #undef __FUNCT__
1732b4ed282SShri Abhyankar #define __FUNCT__ "SNESVIComputeMeritFunction"
1742b4ed282SShri Abhyankar static PetscErrorCode SNESVIComputeMeritFunction(Vec phi, PetscReal* merit,PetscReal* phinorm)
1752b4ed282SShri Abhyankar {
1762b4ed282SShri Abhyankar   PetscErrorCode ierr;
1772b4ed282SShri Abhyankar 
1782b4ed282SShri Abhyankar   PetscFunctionBegin;
1792b4ed282SShri Abhyankar   ierr = VecNormBegin(phi,NORM_2,phinorm);
1802b4ed282SShri Abhyankar   ierr = VecNormEnd(phi,NORM_2,phinorm);
1812b4ed282SShri Abhyankar 
1822b4ed282SShri Abhyankar   *merit = 0.5*(*phinorm)*(*phinorm);
1832b4ed282SShri Abhyankar   PetscFunctionReturn(0);
1842b4ed282SShri Abhyankar }
1852b4ed282SShri Abhyankar 
1862b4ed282SShri Abhyankar /*
1872b4ed282SShri Abhyankar   ComputeFischerFunction - Computes the semismooth fischer burmeister function for a mixed complementarity equation.
1882b4ed282SShri Abhyankar 
1892b4ed282SShri Abhyankar   Notes:
1902b4ed282SShri Abhyankar   The Fischer-Burmeister function is defined as
1912b4ed282SShri Abhyankar        ff(a,b) := sqrt(a*a + b*b) - a - b
1922b4ed282SShri Abhyankar   and is used reformulate a complementarity equation  as a semismooth equation.
1932b4ed282SShri Abhyankar */
1942b4ed282SShri Abhyankar 
1952b4ed282SShri Abhyankar #undef __FUNCT__
1962b4ed282SShri Abhyankar #define __FUNCT__ "ComputeFischerFunction"
1972b4ed282SShri Abhyankar static PetscErrorCode ComputeFischerFunction(PetscScalar a, PetscScalar b, PetscScalar* ff)
1982b4ed282SShri Abhyankar {
1992b4ed282SShri Abhyankar   PetscFunctionBegin;
2002b4ed282SShri Abhyankar   *ff = sqrt(a*a + b*b) - a - b;
2012b4ed282SShri Abhyankar   PetscFunctionReturn(0);
2022b4ed282SShri Abhyankar }
2032b4ed282SShri Abhyankar 
2042b4ed282SShri Abhyankar /*
2051f79c099SShri Abhyankar    SNESVIComputeFunction - Reformulates a system of nonlinear equations in mixed complementarity form to a system of nonlinear equations in semismooth form.
2062b4ed282SShri Abhyankar 
2072b4ed282SShri Abhyankar    Input Parameters:
2082b4ed282SShri Abhyankar .  snes - the SNES context
2092b4ed282SShri Abhyankar .  x - current iterate
2102b4ed282SShri Abhyankar .  functx - user defined function context
2112b4ed282SShri Abhyankar 
2122b4ed282SShri Abhyankar    Output Parameters:
2132b4ed282SShri Abhyankar .  phi - Semismooth function
2142b4ed282SShri Abhyankar 
2152b4ed282SShri Abhyankar    Notes:
2162b4ed282SShri Abhyankar    The result of this function is done by cases:
2172b4ed282SShri Abhyankar +  l[i] == -infinity, u[i] == infinity  -- phi[i] = -f[i]
2182b4ed282SShri Abhyankar .  l[i] == -infinity, u[i] finite       -- phi[i] = ss(u[i]-x[i], -f[i])
2192b4ed282SShri Abhyankar .  l[i] finite,       u[i] == infinity  -- phi[i] = ss(x[i]-l[i],  f[i])
2202b4ed282SShri Abhyankar .  l[i] finite < u[i] finite -- phi[i] = phi(x[i]-l[i], ss(u[i]-x[i], -f[u]))
2212b4ed282SShri Abhyankar -  otherwise l[i] == u[i] -- phi[i] = l[i] - x[i]
2222b4ed282SShri Abhyankar    ss is the semismoothing function used to reformulate the nonlinear equation in complementarity
2232b4ed282SShri Abhyankar    form to semismooth form
2242b4ed282SShri Abhyankar 
2252b4ed282SShri Abhyankar */
2262b4ed282SShri Abhyankar #undef __FUNCT__
2271f79c099SShri Abhyankar #define __FUNCT__ "SNESVIComputeFunction"
2281f79c099SShri Abhyankar static PetscErrorCode SNESVIComputeFunction(SNES snes,Vec X,Vec phi,void* functx)
2292b4ed282SShri Abhyankar {
2302b4ed282SShri Abhyankar   PetscErrorCode  ierr;
2312b4ed282SShri Abhyankar   SNES_VI       *vi = (SNES_VI*)snes->data;
2322b4ed282SShri Abhyankar   Vec             Xl = vi->xl,Xu = vi->xu,F = snes->vec_func;
2332b4ed282SShri Abhyankar   PetscScalar     *phi_arr,*x_arr,*f_arr,*l,*u,t;
2342b4ed282SShri Abhyankar   PetscInt        i,nlocal;
2352b4ed282SShri Abhyankar 
2362b4ed282SShri Abhyankar   PetscFunctionBegin;
2372b4ed282SShri Abhyankar   ierr = (*vi->computeuserfunction)(snes,X,F,functx);CHKERRQ(ierr);
2382b4ed282SShri Abhyankar   ierr = VecGetLocalSize(X,&nlocal);CHKERRQ(ierr);
2392b4ed282SShri Abhyankar 
2402b4ed282SShri Abhyankar   ierr = VecGetArray(X,&x_arr);CHKERRQ(ierr);
2412b4ed282SShri Abhyankar   ierr = VecGetArray(F,&f_arr);CHKERRQ(ierr);
2422b4ed282SShri Abhyankar   ierr = VecGetArray(Xl,&l);CHKERRQ(ierr);
2432b4ed282SShri Abhyankar   ierr = VecGetArray(Xu,&u);CHKERRQ(ierr);
2442b4ed282SShri Abhyankar   ierr = VecGetArray(phi,&phi_arr);CHKERRQ(ierr);
2452b4ed282SShri Abhyankar 
2462b4ed282SShri Abhyankar   for (i=0;i < nlocal;i++) {
2472b4ed282SShri Abhyankar     if ((l[i] <= PETSC_VI_NINF) && (u[i] >= PETSC_VI_INF)) {
2482b4ed282SShri Abhyankar       phi_arr[i] = -f_arr[i];
2492b4ed282SShri Abhyankar     }
2502b4ed282SShri Abhyankar     else if (l[i] <= PETSC_VI_NINF) {
2512b4ed282SShri Abhyankar       t = u[i] - x_arr[i];
2522b4ed282SShri Abhyankar       ierr = ComputeFischerFunction(t,-f_arr[i],&phi_arr[i]);CHKERRQ(ierr);
2532b4ed282SShri Abhyankar       phi_arr[i] = -phi_arr[i];
2542b4ed282SShri Abhyankar     }
2552b4ed282SShri Abhyankar     else if (u[i] >= PETSC_VI_INF) {
2562b4ed282SShri Abhyankar       t = x_arr[i] - l[i];
2572b4ed282SShri Abhyankar       ierr = ComputeFischerFunction(t,f_arr[i],&phi_arr[i]);CHKERRQ(ierr);
2582b4ed282SShri Abhyankar     }
2592b4ed282SShri Abhyankar     else if (l[i] == u[i]) {
2602b4ed282SShri Abhyankar       phi_arr[i] = l[i] - x_arr[i];
2612b4ed282SShri Abhyankar     }
2622b4ed282SShri Abhyankar     else {
2632b4ed282SShri Abhyankar       t = u[i] - x_arr[i];
2642b4ed282SShri Abhyankar       ierr = ComputeFischerFunction(t,-f_arr[i],&phi_arr[i]);
2652b4ed282SShri Abhyankar       t = x_arr[i] - l[i];
2662b4ed282SShri Abhyankar       ierr = ComputeFischerFunction(t,phi_arr[i],&phi_arr[i]);
2672b4ed282SShri Abhyankar     }
2682b4ed282SShri Abhyankar   }
2692b4ed282SShri Abhyankar 
2702b4ed282SShri Abhyankar   ierr = VecRestoreArray(X,&x_arr);CHKERRQ(ierr);
2712b4ed282SShri Abhyankar   ierr = VecRestoreArray(F,&f_arr);CHKERRQ(ierr);
2722b4ed282SShri Abhyankar   ierr = VecRestoreArray(Xl,&l);CHKERRQ(ierr);
2732b4ed282SShri Abhyankar   ierr = VecRestoreArray(Xu,&u);CHKERRQ(ierr);
2742b4ed282SShri Abhyankar   ierr = VecRestoreArray(phi,&phi_arr);CHKERRQ(ierr);
2752b4ed282SShri Abhyankar 
2762b4ed282SShri Abhyankar   PetscFunctionReturn(0);
2772b4ed282SShri Abhyankar }
2782b4ed282SShri Abhyankar 
2792b4ed282SShri Abhyankar /*
280a79edbefSShri Abhyankar    SNESVIComputeBsubdifferentialVectors - Computes the diagonal shift (Da) and row scaling (Db) vectors needed for the
281a79edbefSShri Abhyankar                                           the semismooth jacobian.
2822b4ed282SShri Abhyankar */
2832b4ed282SShri Abhyankar #undef __FUNCT__
284a79edbefSShri Abhyankar #define __FUNCT__ "SNESVIComputeBsubdifferentialVectors"
285a79edbefSShri Abhyankar PetscErrorCode SNESVIComputeBsubdifferentialVectors(SNES snes,Vec X,Vec F,Mat jac,Vec Da,Vec Db)
2862b4ed282SShri Abhyankar {
2872b4ed282SShri Abhyankar   PetscErrorCode ierr;
2882b4ed282SShri Abhyankar   SNES_VI      *vi = (SNES_VI*)snes->data;
2892b4ed282SShri Abhyankar   PetscScalar    *l,*u,*x,*f,*da,*db,*z,*t,t1,t2,ci,di,ei;
2902b4ed282SShri Abhyankar   PetscInt       i,nlocal;
2912b4ed282SShri Abhyankar 
2922b4ed282SShri Abhyankar   PetscFunctionBegin;
2932b4ed282SShri Abhyankar 
2942b4ed282SShri Abhyankar   ierr = VecGetArray(X,&x);CHKERRQ(ierr);
2952b4ed282SShri Abhyankar   ierr = VecGetArray(F,&f);CHKERRQ(ierr);
2962b4ed282SShri Abhyankar   ierr = VecGetArray(vi->xl,&l);CHKERRQ(ierr);
2972b4ed282SShri Abhyankar   ierr = VecGetArray(vi->xu,&u);CHKERRQ(ierr);
298a79edbefSShri Abhyankar   ierr = VecGetArray(Da,&da);CHKERRQ(ierr);
299a79edbefSShri Abhyankar   ierr = VecGetArray(Db,&db);CHKERRQ(ierr);
3002b4ed282SShri Abhyankar   ierr = VecGetArray(vi->z,&z);CHKERRQ(ierr);
3012b4ed282SShri Abhyankar 
3022b4ed282SShri Abhyankar   ierr = VecGetLocalSize(X,&nlocal);CHKERRQ(ierr);
3032b4ed282SShri Abhyankar   /* Set the elements of the vector z:
3042b4ed282SShri Abhyankar      z[i] = 1 if (x[i] - l[i],f[i]) = (0,0) or (u[i] - x[i],f[i]) = (0,0)
3052b4ed282SShri Abhyankar      else z[i] = 0
3062b4ed282SShri Abhyankar   */
3072b4ed282SShri Abhyankar   for(i=0;i < nlocal;i++) {
3082b4ed282SShri Abhyankar     da[i] = db[i] = z[i] = 0;
3092b4ed282SShri Abhyankar     if(PetscAbsScalar(f[i]) <= vi->const_tol) {
3102b4ed282SShri Abhyankar       if ((l[i] > PETSC_VI_NINF) && (PetscAbsScalar(x[i]-l[i]) <= vi->const_tol)) {
3112b4ed282SShri Abhyankar 	da[i] = 1;
3122b4ed282SShri Abhyankar 	z[i]  = 1;
3132b4ed282SShri Abhyankar       }
3142b4ed282SShri Abhyankar       if ((u[i] < PETSC_VI_INF) && (PetscAbsScalar(u[i]-x[i]) <= vi->const_tol)) {
3152b4ed282SShri Abhyankar 	db[i] = 1;
3162b4ed282SShri Abhyankar 	z[i]  = 1;
3172b4ed282SShri Abhyankar       }
3182b4ed282SShri Abhyankar     }
3192b4ed282SShri Abhyankar   }
3202b4ed282SShri Abhyankar   ierr = VecRestoreArray(vi->z,&z);CHKERRQ(ierr);
321a79edbefSShri Abhyankar   ierr = MatMult(jac,vi->z,vi->t);CHKERRQ(ierr);
3222b4ed282SShri Abhyankar   ierr = VecGetArray(vi->t,&t);CHKERRQ(ierr);
3232b4ed282SShri Abhyankar   /* Compute the elements of the diagonal perturbation vector Da and row scaling vector Db */
3242b4ed282SShri Abhyankar   for(i=0;i< nlocal;i++) {
3252b4ed282SShri Abhyankar     /* Free variables */
3262b4ed282SShri Abhyankar     if ((l[i] <= PETSC_VI_NINF) && (u[i] >= PETSC_VI_INF)) {
3272b4ed282SShri Abhyankar       da[i] = 0; db[i] = -1;
3282b4ed282SShri Abhyankar     }
3292b4ed282SShri Abhyankar     /* lower bounded variables */
3302b4ed282SShri Abhyankar     else if (u[i] >= PETSC_VI_INF) {
3312b4ed282SShri Abhyankar       if (da[i] >= 1) {
3322b4ed282SShri Abhyankar 	t2 = PetscScalarNorm(1,t[i]);
3332b4ed282SShri Abhyankar 	da[i] = 1/t2 - 1;
3342b4ed282SShri Abhyankar 	db[i] = t[i]/t2 - 1;
3352b4ed282SShri Abhyankar       } else {
3362b4ed282SShri Abhyankar 	t1 = x[i] - l[i];
3372b4ed282SShri Abhyankar 	t2 = PetscScalarNorm(t1,f[i]);
3382b4ed282SShri Abhyankar 	da[i] = t1/t2 - 1;
3392b4ed282SShri Abhyankar 	db[i] = f[i]/t2 - 1;
3402b4ed282SShri Abhyankar       }
3412b4ed282SShri Abhyankar     }
3422b4ed282SShri Abhyankar     /* upper bounded variables */
3432b4ed282SShri Abhyankar     else if (l[i] <= PETSC_VI_NINF) {
3442b4ed282SShri Abhyankar       if (db[i] >= 1) {
3452b4ed282SShri Abhyankar 	t2 = PetscScalarNorm(1,t[i]);
3462b4ed282SShri Abhyankar 	da[i] = -1/t2 -1;
3472b4ed282SShri Abhyankar 	db[i] = -t[i]/t2 - 1;
3482b4ed282SShri Abhyankar       }
3492b4ed282SShri Abhyankar       else {
3502b4ed282SShri Abhyankar 	t1 = u[i] - x[i];
3512b4ed282SShri Abhyankar 	t2 = PetscScalarNorm(t1,f[i]);
3522b4ed282SShri Abhyankar 	da[i] = t1/t2 - 1;
3532b4ed282SShri Abhyankar 	db[i] = -f[i]/t2 - 1;
3542b4ed282SShri Abhyankar       }
3552b4ed282SShri Abhyankar     }
3562b4ed282SShri Abhyankar     /* Fixed variables */
3572b4ed282SShri Abhyankar     else if (l[i] == u[i]) {
3582b4ed282SShri Abhyankar       da[i] = -1;
3592b4ed282SShri Abhyankar       db[i] = 0;
3602b4ed282SShri Abhyankar     }
3612b4ed282SShri Abhyankar     /* Box constrained variables */
3622b4ed282SShri Abhyankar     else {
3632b4ed282SShri Abhyankar       if (db[i] >= 1) {
3642b4ed282SShri Abhyankar 	t2 = PetscScalarNorm(1,t[i]);
3652b4ed282SShri Abhyankar 	ci = 1/t2 + 1;
3662b4ed282SShri Abhyankar 	di = t[i]/t2 + 1;
3672b4ed282SShri Abhyankar       }
3682b4ed282SShri Abhyankar       else {
3692b4ed282SShri Abhyankar 	t1 = x[i] - u[i];
3702b4ed282SShri Abhyankar 	t2 = PetscScalarNorm(t1,f[i]);
3712b4ed282SShri Abhyankar 	ci = t1/t2 + 1;
3722b4ed282SShri Abhyankar 	di = f[i]/t2 + 1;
3732b4ed282SShri Abhyankar       }
3742b4ed282SShri Abhyankar 
3752b4ed282SShri Abhyankar       if (da[i] >= 1) {
3762b4ed282SShri Abhyankar 	t1 = ci + di*t[i];
3772b4ed282SShri Abhyankar 	t2 = PetscScalarNorm(1,t1);
3782b4ed282SShri Abhyankar 	t1 = t1/t2 - 1;
3792b4ed282SShri Abhyankar 	t2 = 1/t2  - 1;
3802b4ed282SShri Abhyankar       }
3812b4ed282SShri Abhyankar       else {
3822b4ed282SShri Abhyankar 	ierr = ComputeFischerFunction(u[i]-x[i],-f[i],&ei);CHKERRQ(ierr);
3832b4ed282SShri Abhyankar 	t2 = PetscScalarNorm(x[i]-l[i],ei);
3842b4ed282SShri Abhyankar 	t1 = ei/t2 - 1;
3852b4ed282SShri Abhyankar 	t2 = (x[i] - l[i])/t2 - 1;
3862b4ed282SShri Abhyankar       }
3872b4ed282SShri Abhyankar 
3882b4ed282SShri Abhyankar       da[i] = t2 + t1*ci;
3892b4ed282SShri Abhyankar       db[i] = t1*di;
3902b4ed282SShri Abhyankar     }
3912b4ed282SShri Abhyankar   }
3922b4ed282SShri Abhyankar   ierr = VecRestoreArray(X,&x);CHKERRQ(ierr);
3932b4ed282SShri Abhyankar   ierr = VecRestoreArray(F,&f);CHKERRQ(ierr);
3942b4ed282SShri Abhyankar   ierr = VecRestoreArray(vi->xl,&l);CHKERRQ(ierr);
3952b4ed282SShri Abhyankar   ierr = VecRestoreArray(vi->xu,&u);CHKERRQ(ierr);
396a79edbefSShri Abhyankar   ierr = VecRestoreArray(Da,&da);CHKERRQ(ierr);
397a79edbefSShri Abhyankar   ierr = VecRestoreArray(Db,&db);CHKERRQ(ierr);
3982b4ed282SShri Abhyankar   ierr = VecRestoreArray(vi->t,&t);CHKERRQ(ierr);
3992b4ed282SShri Abhyankar 
400a79edbefSShri Abhyankar   PetscFunctionReturn(0);
401a79edbefSShri Abhyankar }
402a79edbefSShri Abhyankar 
403a79edbefSShri Abhyankar /*
404a79edbefSShri 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.
405a79edbefSShri Abhyankar 
406a79edbefSShri Abhyankar    Input Parameters:
407a79edbefSShri Abhyankar .  Da       - Diagonal shift vector for the semismooth jacobian.
408a79edbefSShri Abhyankar .  Db       - Row scaling vector for the semismooth jacobian.
409a79edbefSShri Abhyankar 
410a79edbefSShri Abhyankar    Output Parameters:
411a79edbefSShri Abhyankar .  jac      - semismooth jacobian
412a79edbefSShri Abhyankar .  jac_pre  - optional preconditioning matrix
413a79edbefSShri Abhyankar 
414a79edbefSShri Abhyankar    Notes:
415a79edbefSShri Abhyankar    The semismooth jacobian matrix is given by
416a79edbefSShri Abhyankar    jac = Da + Db*jacfun
417a79edbefSShri Abhyankar    where Db is the row scaling matrix stored as a vector,
418a79edbefSShri Abhyankar          Da is the diagonal perturbation matrix stored as a vector
419a79edbefSShri Abhyankar    and   jacfun is the jacobian of the original nonlinear function.
420a79edbefSShri Abhyankar */
421a79edbefSShri Abhyankar #undef __FUNCT__
422a79edbefSShri Abhyankar #define __FUNCT__ "SNESVIComputeJacobian"
423a79edbefSShri Abhyankar PetscErrorCode SNESVIComputeJacobian(Mat jac, Mat jac_pre,Vec Da, Vec Db)
424a79edbefSShri Abhyankar {
425a79edbefSShri Abhyankar   PetscErrorCode ierr;
426a79edbefSShri Abhyankar 
4272b4ed282SShri Abhyankar   /* Do row scaling  and add diagonal perturbation */
428a79edbefSShri Abhyankar   ierr = MatDiagonalScale(jac,Db,PETSC_NULL);CHKERRQ(ierr);
429a79edbefSShri Abhyankar   ierr = MatDiagonalSet(jac,Da,ADD_VALUES);CHKERRQ(ierr);
430a79edbefSShri Abhyankar   if (jac != jac_pre) { /* If jac and jac_pre are different */
431a79edbefSShri Abhyankar     ierr = MatDiagonalScale(jac_pre,Db,PETSC_NULL);
432a79edbefSShri Abhyankar     ierr = MatDiagonalSet(jac_pre,Da,ADD_VALUES);CHKERRQ(ierr);
4332b4ed282SShri Abhyankar   }
4342b4ed282SShri Abhyankar   PetscFunctionReturn(0);
4352b4ed282SShri Abhyankar }
4362b4ed282SShri Abhyankar 
4372b4ed282SShri Abhyankar /*
438ee657d29SShri Abhyankar    SNESVIComputeMeritFunctionGradient - Computes the gradient of the merit function psi.
439ee657d29SShri Abhyankar 
440ee657d29SShri Abhyankar    Input Parameters:
441ee657d29SShri Abhyankar    phi - semismooth function.
442ee657d29SShri Abhyankar    H   - semismooth jacobian
443ee657d29SShri Abhyankar 
444ee657d29SShri Abhyankar    Output Parameters:
445ee657d29SShri Abhyankar    dpsi - merit function gradient
446ee657d29SShri Abhyankar 
447ee657d29SShri Abhyankar    Notes:
448ee657d29SShri Abhyankar   The merit function gradient is computed as follows
449ee657d29SShri Abhyankar         dpsi = H^T*phi
450ee657d29SShri Abhyankar */
451ee657d29SShri Abhyankar #undef __FUNCT__
452ee657d29SShri Abhyankar #define __FUNCT__ "SNESVIComputeMeritFunctionGradient"
453ee657d29SShri Abhyankar PetscErrorCode SNESVIComputeMeritFunctionGradient(Mat H, Vec phi, Vec dpsi)
454ee657d29SShri Abhyankar {
455ee657d29SShri Abhyankar   PetscErrorCode ierr;
456ee657d29SShri Abhyankar 
457ee657d29SShri Abhyankar   PetscFunctionBegin;
458ee657d29SShri Abhyankar   ierr = MatMultTranspose(H,phi,dpsi);
459ee657d29SShri Abhyankar   PetscFunctionReturn(0);
460ee657d29SShri Abhyankar }
461ee657d29SShri Abhyankar 
462*c1a5e521SShri Abhyankar /* -------------------------------------------------------------------------- */
463*c1a5e521SShri Abhyankar /*
464*c1a5e521SShri Abhyankar    SNESVIProjectOntoBounds - Projects X onto the feasible region so that Xl[i] <= X[i] <= Xu[i] for i = 1...n.
465*c1a5e521SShri Abhyankar 
466*c1a5e521SShri Abhyankar    Input Parameters:
467*c1a5e521SShri Abhyankar .  SNES - nonlinear solver context
468*c1a5e521SShri Abhyankar 
469*c1a5e521SShri Abhyankar    Output Parameters:
470*c1a5e521SShri Abhyankar .  X - Bound projected X
471*c1a5e521SShri Abhyankar 
472*c1a5e521SShri Abhyankar */
473*c1a5e521SShri Abhyankar 
474*c1a5e521SShri Abhyankar #undef __FUNCT__
475*c1a5e521SShri Abhyankar #define __FUNCT__ "SNESVIProjectOntoBounds"
476*c1a5e521SShri Abhyankar PetscErrorCode SNESVIProjectOntoBounds(SNES snes,Vec X)
477*c1a5e521SShri Abhyankar {
478*c1a5e521SShri Abhyankar   PetscErrorCode    ierr;
479*c1a5e521SShri Abhyankar   SNES_VI           *vi = (SNES_VI*)snes->data;
480*c1a5e521SShri Abhyankar   const PetscScalar *xl,*xu;
481*c1a5e521SShri Abhyankar   PetscScalar       *x;
482*c1a5e521SShri Abhyankar   PetscInt          i,n;
483*c1a5e521SShri Abhyankar 
484*c1a5e521SShri Abhyankar   PetscFunctionBegin;
485*c1a5e521SShri Abhyankar 
486*c1a5e521SShri Abhyankar   ierr = VecGetLocalSize(X,&n);CHKERRQ(ierr);
487*c1a5e521SShri Abhyankar   ierr = VecGetArray(X,&x);CHKERRQ(ierr);
488*c1a5e521SShri Abhyankar   ierr = VecGetArrayRead(vi->xl,&xl);CHKERRQ(ierr);
489*c1a5e521SShri Abhyankar   ierr = VecGetArrayRead(vi->xu,&xu);CHKERRQ(ierr);
490*c1a5e521SShri Abhyankar 
491*c1a5e521SShri Abhyankar   for(i = 0;i<n;i++) {
492*c1a5e521SShri Abhyankar     if (x[i] < xl[i]) x[i] = xl[i];
493*c1a5e521SShri Abhyankar     else if (x[i] > xu[i]) x[i] = xu[i];
494*c1a5e521SShri Abhyankar   }
495*c1a5e521SShri Abhyankar   ierr = VecRestoreArray(X,&x);CHKERRQ(ierr);
496*c1a5e521SShri Abhyankar   ierr = VecRestoreArrayRead(vi->xl,&xl);CHKERRQ(ierr);
497*c1a5e521SShri Abhyankar   ierr = VecRestoreArrayRead(vi->xu,&xu);CHKERRQ(ierr);
498*c1a5e521SShri Abhyankar 
499*c1a5e521SShri Abhyankar   PetscFunctionReturn(0);
500*c1a5e521SShri Abhyankar }
501*c1a5e521SShri Abhyankar 
502*c1a5e521SShri Abhyankar 
503ee657d29SShri Abhyankar /*
5042b4ed282SShri Abhyankar    SNESVIAdjustInitialGuess - Readjusts the initial guess to the SNES solver supplied by the user so that the initial guess lies inside the feasible region .
5052b4ed282SShri Abhyankar 
5062b4ed282SShri Abhyankar    Input Parameters:
5072b4ed282SShri Abhyankar .  lb - lower bound.
5082b4ed282SShri Abhyankar .  ub - upper bound.
5092b4ed282SShri Abhyankar 
5102b4ed282SShri Abhyankar    Output Parameters:
5112b4ed282SShri Abhyankar .  X - the readjusted initial guess.
5122b4ed282SShri Abhyankar 
5132b4ed282SShri Abhyankar    Notes:
5142b4ed282SShri Abhyankar    The readjusted initial guess X[i] = max(max(min(l[i],X[i]),min(X[i],u[i])),min(l[i],u[i]))
5152b4ed282SShri Abhyankar */
5162b4ed282SShri Abhyankar #undef __FUNCT__
5172b4ed282SShri Abhyankar #define __FUNCT__ "SNESVIAdjustInitialGuess"
5182b4ed282SShri Abhyankar PetscErrorCode SNESVIAdjustInitialGuess(Vec X, Vec lb, Vec ub)
5192b4ed282SShri Abhyankar {
5202b4ed282SShri Abhyankar   PetscErrorCode ierr;
5212b4ed282SShri Abhyankar   PetscInt       i,nlocal;
5222b4ed282SShri Abhyankar   PetscScalar    *x,*l,*u;
5232b4ed282SShri Abhyankar 
5242b4ed282SShri Abhyankar   PetscFunctionBegin;
5252b4ed282SShri Abhyankar 
5262b4ed282SShri Abhyankar   ierr = VecGetLocalSize(X,&nlocal);CHKERRQ(ierr);
5272b4ed282SShri Abhyankar   ierr = VecGetArray(X,&x);CHKERRQ(ierr);
5282b4ed282SShri Abhyankar   ierr = VecGetArray(lb,&l);CHKERRQ(ierr);
5292b4ed282SShri Abhyankar   ierr = VecGetArray(ub,&u);CHKERRQ(ierr);
5302b4ed282SShri Abhyankar 
5312b4ed282SShri Abhyankar   for(i = 0; i < nlocal; i++) {
5322b4ed282SShri Abhyankar     x[i] = PetscMax(PetscMax(PetscMin(x[i],l[i]),PetscMin(x[i],u[i])),PetscMin(l[i],u[i]));
5332b4ed282SShri Abhyankar   }
5342b4ed282SShri Abhyankar 
5352b4ed282SShri Abhyankar   ierr = VecRestoreArray(X,&x);CHKERRQ(ierr);
5362b4ed282SShri Abhyankar   ierr = VecRestoreArray(lb,&l);CHKERRQ(ierr);
5372b4ed282SShri Abhyankar   ierr = VecRestoreArray(ub,&u);CHKERRQ(ierr);
5382b4ed282SShri Abhyankar 
5392b4ed282SShri Abhyankar   PetscFunctionReturn(0);
5402b4ed282SShri Abhyankar }
5412b4ed282SShri Abhyankar 
5422b4ed282SShri Abhyankar /*  --------------------------------------------------------------------
5432b4ed282SShri Abhyankar 
5442b4ed282SShri Abhyankar      This file implements a semismooth truncated Newton method with a line search,
5452b4ed282SShri Abhyankar      for solving a system of nonlinear equations in complementarity form, using the KSP, Vec,
5462b4ed282SShri Abhyankar      and Mat interfaces for linear solvers, vectors, and matrices,
5472b4ed282SShri Abhyankar      respectively.
5482b4ed282SShri Abhyankar 
5492b4ed282SShri Abhyankar      The following basic routines are required for each nonlinear solver:
5502b4ed282SShri Abhyankar           SNESCreate_XXX()          - Creates a nonlinear solver context
5512b4ed282SShri Abhyankar           SNESSetFromOptions_XXX()  - Sets runtime options
5522b4ed282SShri Abhyankar           SNESSolve_XXX()           - Solves the nonlinear system
5532b4ed282SShri Abhyankar           SNESDestroy_XXX()         - Destroys the nonlinear solver context
5542b4ed282SShri Abhyankar      The suffix "_XXX" denotes a particular implementation, in this case
5552b4ed282SShri Abhyankar      we use _VI (e.g., SNESCreate_VI, SNESSolve_VI) for solving
5562b4ed282SShri Abhyankar      systems of nonlinear equations with a line search (LS) method.
5572b4ed282SShri Abhyankar      These routines are actually called via the common user interface
5582b4ed282SShri Abhyankar      routines SNESCreate(), SNESSetFromOptions(), SNESSolve(), and
5592b4ed282SShri Abhyankar      SNESDestroy(), so the application code interface remains identical
5602b4ed282SShri Abhyankar      for all nonlinear solvers.
5612b4ed282SShri Abhyankar 
5622b4ed282SShri Abhyankar      Another key routine is:
5632b4ed282SShri Abhyankar           SNESSetUp_XXX()           - Prepares for the use of a nonlinear solver
5642b4ed282SShri Abhyankar      by setting data structures and options.   The interface routine SNESSetUp()
5652b4ed282SShri Abhyankar      is not usually called directly by the user, but instead is called by
5662b4ed282SShri Abhyankar      SNESSolve() if necessary.
5672b4ed282SShri Abhyankar 
5682b4ed282SShri Abhyankar      Additional basic routines are:
5692b4ed282SShri Abhyankar           SNESView_XXX()            - Prints details of runtime options that
5702b4ed282SShri Abhyankar                                       have actually been used.
5712b4ed282SShri Abhyankar      These are called by application codes via the interface routines
5722b4ed282SShri Abhyankar      SNESView().
5732b4ed282SShri Abhyankar 
5742b4ed282SShri Abhyankar      The various types of solvers (preconditioners, Krylov subspace methods,
5752b4ed282SShri Abhyankar      nonlinear solvers, timesteppers) are all organized similarly, so the
5762b4ed282SShri Abhyankar      above description applies to these categories also.
5772b4ed282SShri Abhyankar 
5782b4ed282SShri Abhyankar     -------------------------------------------------------------------- */
5792b4ed282SShri Abhyankar /*
58069c03620SShri Abhyankar    SNESSolveVI_SS - Solves the complementarity problem with a semismooth Newton
5812b4ed282SShri Abhyankar    method using a line search.
5822b4ed282SShri Abhyankar 
5832b4ed282SShri Abhyankar    Input Parameters:
5842b4ed282SShri Abhyankar .  snes - the SNES context
5852b4ed282SShri Abhyankar 
5862b4ed282SShri Abhyankar    Output Parameter:
5872b4ed282SShri Abhyankar .  outits - number of iterations until termination
5882b4ed282SShri Abhyankar 
5892b4ed282SShri Abhyankar    Application Interface Routine: SNESSolve()
5902b4ed282SShri Abhyankar 
5912b4ed282SShri Abhyankar    Notes:
5922b4ed282SShri Abhyankar    This implements essentially a semismooth Newton method with a
5932b4ed282SShri Abhyankar    line search.  By default a cubic backtracking line search
5942b4ed282SShri Abhyankar    is employed, as described in the text "Numerical Methods for
5952b4ed282SShri Abhyankar    Unconstrained Optimization and Nonlinear Equations" by Dennis
5962b4ed282SShri Abhyankar    and Schnabel.
5972b4ed282SShri Abhyankar */
5982b4ed282SShri Abhyankar #undef __FUNCT__
59969c03620SShri Abhyankar #define __FUNCT__ "SNESSolveVI_SS"
60069c03620SShri Abhyankar PetscErrorCode SNESSolveVI_SS(SNES snes)
6012b4ed282SShri Abhyankar {
6022b4ed282SShri Abhyankar   SNES_VI            *vi = (SNES_VI*)snes->data;
6032b4ed282SShri Abhyankar   PetscErrorCode     ierr;
6042b4ed282SShri Abhyankar   PetscInt           maxits,i,lits;
6053b336b49SShri Abhyankar   PetscBool          lssucceed;
6062b4ed282SShri Abhyankar   MatStructure       flg = DIFFERENT_NONZERO_PATTERN;
6072b4ed282SShri Abhyankar   PetscReal          gnorm,xnorm=0,ynorm;
6082b4ed282SShri Abhyankar   Vec                Y,X,F,G,W;
6092b4ed282SShri Abhyankar   KSPConvergedReason kspreason;
6102b4ed282SShri Abhyankar 
6112b4ed282SShri Abhyankar   PetscFunctionBegin;
6122b4ed282SShri Abhyankar   snes->numFailures            = 0;
6132b4ed282SShri Abhyankar   snes->numLinearSolveFailures = 0;
6142b4ed282SShri Abhyankar   snes->reason                 = SNES_CONVERGED_ITERATING;
6152b4ed282SShri Abhyankar 
6162b4ed282SShri Abhyankar   maxits	= snes->max_its;	/* maximum number of iterations */
6172b4ed282SShri Abhyankar   X		= snes->vec_sol;	/* solution vector */
6182b4ed282SShri Abhyankar   F		= snes->vec_func;	/* residual vector */
6192b4ed282SShri Abhyankar   Y		= snes->work[0];	/* work vectors */
6202b4ed282SShri Abhyankar   G		= snes->work[1];
6212b4ed282SShri Abhyankar   W		= snes->work[2];
6222b4ed282SShri Abhyankar 
6232b4ed282SShri Abhyankar   ierr = PetscObjectTakeAccess(snes);CHKERRQ(ierr);
6242b4ed282SShri Abhyankar   snes->iter = 0;
6252b4ed282SShri Abhyankar   snes->norm = 0.0;
6262b4ed282SShri Abhyankar   ierr = PetscObjectGrantAccess(snes);CHKERRQ(ierr);
6272b4ed282SShri Abhyankar 
6282b4ed282SShri Abhyankar   ierr = SNESVIAdjustInitialGuess(X,vi->xl,vi->xu);CHKERRQ(ierr);
6292b4ed282SShri Abhyankar   ierr = SNESComputeFunction(snes,X,vi->phi);CHKERRQ(ierr);
6302b4ed282SShri Abhyankar   if (snes->domainerror) {
6312b4ed282SShri Abhyankar     snes->reason = SNES_DIVERGED_FUNCTION_DOMAIN;
6322b4ed282SShri Abhyankar     PetscFunctionReturn(0);
6332b4ed282SShri Abhyankar   }
6342b4ed282SShri Abhyankar    /* Compute Merit function */
6352b4ed282SShri Abhyankar   ierr = SNESVIComputeMeritFunction(vi->phi,&vi->merit,&vi->phinorm);CHKERRQ(ierr);
6362b4ed282SShri Abhyankar 
6372b4ed282SShri Abhyankar   ierr = VecNormBegin(X,NORM_2,&xnorm);CHKERRQ(ierr);	/* xnorm <- ||x||  */
6382b4ed282SShri Abhyankar   ierr = VecNormEnd(X,NORM_2,&xnorm);CHKERRQ(ierr);
6392b4ed282SShri Abhyankar   if PetscIsInfOrNanReal(vi->merit) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FP,"User provided compute function generated a Not-a-Number");
6402b4ed282SShri Abhyankar 
6412b4ed282SShri Abhyankar   ierr = PetscObjectTakeAccess(snes);CHKERRQ(ierr);
6422b4ed282SShri Abhyankar   snes->norm = vi->phinorm;
6432b4ed282SShri Abhyankar   ierr = PetscObjectGrantAccess(snes);CHKERRQ(ierr);
6442b4ed282SShri Abhyankar   SNESLogConvHistory(snes,vi->phinorm,0);
6452b4ed282SShri Abhyankar   SNESMonitor(snes,0,vi->phinorm);
6462b4ed282SShri Abhyankar 
6472b4ed282SShri Abhyankar   /* set parameter for default relative tolerance convergence test */
6482b4ed282SShri Abhyankar   snes->ttol = vi->phinorm*snes->rtol;
6492b4ed282SShri Abhyankar   /* test convergence */
6502b4ed282SShri Abhyankar   ierr = (*snes->ops->converged)(snes,0,0.0,0.0,vi->phinorm,&snes->reason,snes->cnvP);CHKERRQ(ierr);
6512b4ed282SShri Abhyankar   if (snes->reason) PetscFunctionReturn(0);
6522b4ed282SShri Abhyankar 
6532b4ed282SShri Abhyankar   for (i=0; i<maxits; i++) {
6542b4ed282SShri Abhyankar 
6552b4ed282SShri Abhyankar     /* Call general purpose update function */
6562b4ed282SShri Abhyankar     if (snes->ops->update) {
6572b4ed282SShri Abhyankar       ierr = (*snes->ops->update)(snes, snes->iter);CHKERRQ(ierr);
6582b4ed282SShri Abhyankar     }
6592b4ed282SShri Abhyankar 
6602b4ed282SShri Abhyankar     /* Solve J Y = Phi, where J is the semismooth jacobian */
661a79edbefSShri Abhyankar     /* Get the nonlinear function jacobian */
6622b4ed282SShri Abhyankar     ierr = SNESComputeJacobian(snes,X,&snes->jacobian,&snes->jacobian_pre,&flg);CHKERRQ(ierr);
663a79edbefSShri Abhyankar     /* Get the diagonal shift and row scaling vectors */
664a79edbefSShri Abhyankar     ierr = SNESVIComputeBsubdifferentialVectors(snes,X,F,snes->jacobian,vi->Da,vi->Db);CHKERRQ(ierr);
665a79edbefSShri Abhyankar     /* Compute the semismooth jacobian */
666a79edbefSShri Abhyankar     ierr = SNESVIComputeJacobian(snes->jacobian,snes->jacobian_pre,vi->Da,vi->Db);CHKERRQ(ierr);
667ee657d29SShri Abhyankar     /* Compute the merit function gradient */
668ee657d29SShri Abhyankar     ierr = SNESVIComputeMeritFunctionGradient(snes->jacobian,vi->phi,vi->dpsi);CHKERRQ(ierr);
6692b4ed282SShri Abhyankar     ierr = KSPSetOperators(snes->ksp,snes->jacobian,snes->jacobian_pre,flg);CHKERRQ(ierr);
6702b4ed282SShri Abhyankar     ierr = SNES_KSPSolve(snes,snes->ksp,vi->phi,Y);CHKERRQ(ierr);
6712b4ed282SShri Abhyankar     ierr = KSPGetConvergedReason(snes->ksp,&kspreason);CHKERRQ(ierr);
6723b336b49SShri Abhyankar 
6733b336b49SShri Abhyankar     if (kspreason < 0) {
6742b4ed282SShri Abhyankar       if (++snes->numLinearSolveFailures >= snes->maxLinearSolveFailures) {
6752b4ed282SShri 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);
6762b4ed282SShri Abhyankar         snes->reason = SNES_DIVERGED_LINEAR_SOLVE;
6772b4ed282SShri Abhyankar         break;
6782b4ed282SShri Abhyankar       }
6792b4ed282SShri Abhyankar     }
6802b4ed282SShri Abhyankar     ierr = KSPGetIterationNumber(snes->ksp,&lits);CHKERRQ(ierr);
6812b4ed282SShri Abhyankar     snes->linear_its += lits;
6822b4ed282SShri Abhyankar     ierr = PetscInfo2(snes,"iter=%D, linear solve iterations=%D\n",snes->iter,lits);CHKERRQ(ierr);
6832b4ed282SShri Abhyankar     /*
6842b4ed282SShri Abhyankar     if (vi->precheckstep) {
685ace3abfcSBarry Smith       PetscBool changed_y = PETSC_FALSE;
6862b4ed282SShri Abhyankar       ierr = (*vi->precheckstep)(snes,X,Y,vi->precheck,&changed_y);CHKERRQ(ierr);
6872b4ed282SShri Abhyankar     }
6882b4ed282SShri Abhyankar 
6892b4ed282SShri Abhyankar     if (PetscLogPrintInfo){
6902b4ed282SShri Abhyankar       ierr = SNESVICheckResidual_Private(snes,snes->jacobian,F,Y,G,W);CHKERRQ(ierr);
6912b4ed282SShri Abhyankar     }
6922b4ed282SShri Abhyankar     */
6932b4ed282SShri Abhyankar     /* Compute a (scaled) negative update in the line search routine:
6942b4ed282SShri Abhyankar          Y <- X - lambda*Y
6952b4ed282SShri Abhyankar        and evaluate G = function(Y) (depends on the line search).
6962b4ed282SShri Abhyankar     */
6972b4ed282SShri Abhyankar     ierr = VecCopy(Y,snes->vec_sol_update);CHKERRQ(ierr);
6982b4ed282SShri Abhyankar     ynorm = 1; gnorm = vi->phinorm;
6992b4ed282SShri Abhyankar     ierr = (*vi->LineSearch)(snes,vi->lsP,X,vi->phi,G,Y,W,vi->phinorm,xnorm,&ynorm,&gnorm,&lssucceed);CHKERRQ(ierr);
7002b4ed282SShri Abhyankar     ierr = PetscInfo4(snes,"fnorm=%18.16e, gnorm=%18.16e, ynorm=%18.16e, lssucceed=%d\n",vi->phinorm,gnorm,ynorm,(int)lssucceed);CHKERRQ(ierr);
7012b4ed282SShri Abhyankar     if (snes->reason == SNES_DIVERGED_FUNCTION_COUNT) break;
7022b4ed282SShri Abhyankar     if (snes->domainerror) {
7032b4ed282SShri Abhyankar       snes->reason = SNES_DIVERGED_FUNCTION_DOMAIN;
7042b4ed282SShri Abhyankar       PetscFunctionReturn(0);
7052b4ed282SShri Abhyankar     }
7062b4ed282SShri Abhyankar     if (!lssucceed) {
7072b4ed282SShri Abhyankar       if (++snes->numFailures >= snes->maxFailures) {
708ace3abfcSBarry Smith 	PetscBool ismin;
7092b4ed282SShri Abhyankar         snes->reason = SNES_DIVERGED_LINE_SEARCH;
7102b4ed282SShri Abhyankar         ierr = SNESVICheckLocalMin_Private(snes,snes->jacobian,G,W,gnorm,&ismin);CHKERRQ(ierr);
7112b4ed282SShri Abhyankar         if (ismin) snes->reason = SNES_DIVERGED_LOCAL_MIN;
7122b4ed282SShri Abhyankar         break;
7132b4ed282SShri Abhyankar       }
7142b4ed282SShri Abhyankar     }
7152b4ed282SShri Abhyankar     /* Update function and solution vectors */
7162b4ed282SShri Abhyankar     vi->phinorm = gnorm;
7172b4ed282SShri Abhyankar     vi->merit = 0.5*vi->phinorm*vi->phinorm;
7182b4ed282SShri Abhyankar     ierr = VecCopy(G,vi->phi);CHKERRQ(ierr);
7192b4ed282SShri Abhyankar     ierr = VecCopy(W,X);CHKERRQ(ierr);
7202b4ed282SShri Abhyankar     /* Monitor convergence */
7212b4ed282SShri Abhyankar     ierr = PetscObjectTakeAccess(snes);CHKERRQ(ierr);
7222b4ed282SShri Abhyankar     snes->iter = i+1;
7232b4ed282SShri Abhyankar     snes->norm = vi->phinorm;
7242b4ed282SShri Abhyankar     ierr = PetscObjectGrantAccess(snes);CHKERRQ(ierr);
7252b4ed282SShri Abhyankar     SNESLogConvHistory(snes,snes->norm,lits);
7262b4ed282SShri Abhyankar     SNESMonitor(snes,snes->iter,snes->norm);
7272b4ed282SShri Abhyankar     /* Test for convergence, xnorm = || X || */
7282b4ed282SShri Abhyankar     if (snes->ops->converged != SNESSkipConverged) { ierr = VecNorm(X,NORM_2,&xnorm);CHKERRQ(ierr); }
7292b4ed282SShri Abhyankar     ierr = (*snes->ops->converged)(snes,snes->iter,xnorm,ynorm,vi->phinorm,&snes->reason,snes->cnvP);CHKERRQ(ierr);
7302b4ed282SShri Abhyankar     if (snes->reason) break;
7312b4ed282SShri Abhyankar   }
7322b4ed282SShri Abhyankar   if (i == maxits) {
7332b4ed282SShri Abhyankar     ierr = PetscInfo1(snes,"Maximum number of iterations has been reached: %D\n",maxits);CHKERRQ(ierr);
7342b4ed282SShri Abhyankar     if(!snes->reason) snes->reason = SNES_DIVERGED_MAX_IT;
7352b4ed282SShri Abhyankar   }
7362b4ed282SShri Abhyankar   PetscFunctionReturn(0);
7372b4ed282SShri Abhyankar }
73869c03620SShri Abhyankar 
73969c03620SShri Abhyankar #undef __FUNCT__
74069c03620SShri Abhyankar #define __FUNCT__ "SNESVICreateIndexSets_AS"
741a79edbefSShri Abhyankar PetscErrorCode SNESVICreateIndexSets_AS(SNES snes,Vec Db,PetscReal thresh,IS* ISact,IS* ISinact)
74269c03620SShri Abhyankar {
74369c03620SShri Abhyankar   PetscErrorCode ierr;
74469c03620SShri Abhyankar   PetscInt       i,nlocal,ilow,ihigh,nloc_isact=0,nloc_isinact=0;
74569c03620SShri Abhyankar   PetscInt       *idx_act,*idx_inact,i1=0,i2=0;
74669c03620SShri Abhyankar   PetscScalar    *db;
74769c03620SShri Abhyankar 
74869c03620SShri Abhyankar   PetscFunctionBegin;
74969c03620SShri Abhyankar 
75069c03620SShri Abhyankar   ierr = VecGetLocalSize(Db,&nlocal);CHKERRQ(ierr);
75169c03620SShri Abhyankar   ierr = VecGetOwnershipRange(Db,&ilow,&ihigh);CHKERRQ(ierr);
75269c03620SShri Abhyankar   ierr = VecGetArray(Db,&db);CHKERRQ(ierr);
75369c03620SShri Abhyankar   /* Compute the sizes of the active and inactive sets */
75469c03620SShri Abhyankar   for (i=0; i < nlocal;i++) {
755fca35906SShri Abhyankar     if (PetscAbsScalar(db[i]) <= thresh) nloc_isact++;
756fca35906SShri Abhyankar     else nloc_isinact++;
75769c03620SShri Abhyankar   }
75869c03620SShri Abhyankar   ierr = PetscMalloc(nloc_isact*sizeof(PetscInt),&idx_act);CHKERRQ(ierr);
75969c03620SShri Abhyankar   ierr = PetscMalloc(nloc_isinact*sizeof(PetscInt),&idx_inact);CHKERRQ(ierr);
76069c03620SShri Abhyankar 
76169c03620SShri Abhyankar   /* Creating the indexing arrays */
762fca35906SShri Abhyankar   for(i=0; i < nlocal; i++) {
763fca35906SShri Abhyankar     if (PetscAbsScalar(db[i]) <= thresh) idx_act[i1++] = ilow+i;
764fca35906SShri Abhyankar     else idx_inact[i2++] = ilow+i;
76569c03620SShri Abhyankar   }
76669c03620SShri Abhyankar 
76769c03620SShri Abhyankar   /* Create the index sets */
76869c03620SShri Abhyankar   ierr = ISCreateGeneral(((PetscObject)snes)->comm,nloc_isact,idx_act,PETSC_COPY_VALUES,ISact);CHKERRQ(ierr);
76969c03620SShri Abhyankar   ierr = ISCreateGeneral(((PetscObject)snes)->comm,nloc_isinact,idx_inact,PETSC_COPY_VALUES,ISinact);CHKERRQ(ierr);
77069c03620SShri Abhyankar 
77169c03620SShri Abhyankar   ierr = VecRestoreArray(Db,&db);CHKERRQ(ierr);
77269c03620SShri Abhyankar   ierr = PetscFree(idx_act);CHKERRQ(ierr);
77369c03620SShri Abhyankar   ierr = PetscFree(idx_inact);CHKERRQ(ierr);
77469c03620SShri Abhyankar   PetscFunctionReturn(0);
77569c03620SShri Abhyankar }
77669c03620SShri Abhyankar 
777d950fb63SShri Abhyankar #undef __FUNCT__
778d950fb63SShri Abhyankar #define __FUNCT__ "SNESVICreateIndexSets_RS"
779d950fb63SShri Abhyankar PetscErrorCode SNESVICreateIndexSets_RS(SNES snes,Vec X,Vec Xl, Vec Xu,IS* ISact,IS* ISinact)
780d950fb63SShri Abhyankar {
781d950fb63SShri Abhyankar   PetscErrorCode     ierr;
782d950fb63SShri Abhyankar   PetscInt           i,nlocal,ilow,ihigh,nloc_isact=0,nloc_isinact=0;
783d950fb63SShri Abhyankar   PetscInt          *idx_act,*idx_inact,i1=0,i2=0;
784fe835674SShri Abhyankar   const PetscScalar *x,*xl,*xu,*f;
785d950fb63SShri Abhyankar   Vec                F = snes->vec_func;
786d950fb63SShri Abhyankar 
787d950fb63SShri Abhyankar   PetscFunctionBegin;
788d950fb63SShri Abhyankar 
789d950fb63SShri Abhyankar   ierr = VecGetLocalSize(X,&nlocal);CHKERRQ(ierr);
790d950fb63SShri Abhyankar   ierr = VecGetOwnershipRange(X,&ilow,&ihigh);CHKERRQ(ierr);
791fe835674SShri Abhyankar   ierr = VecGetArrayRead(X,&x);CHKERRQ(ierr);
792fe835674SShri Abhyankar   ierr = VecGetArrayRead(Xl,&xl);CHKERRQ(ierr);
793fe835674SShri Abhyankar   ierr = VecGetArrayRead(Xu,&xu);CHKERRQ(ierr);
794fe835674SShri Abhyankar   ierr = VecGetArrayRead(F,&f);CHKERRQ(ierr);
795d950fb63SShri Abhyankar   /* Compute the sizes of the active and inactive sets */
796d950fb63SShri Abhyankar   for (i=0; i < nlocal;i++) {
797fe835674SShri Abhyankar     if (((x[i] > xl[i] + 1.e-8 || (f[i] < 0.0)) && ((x[i] < xu[i] - 1.e-8) || f[i] > 0.0))) nloc_isinact++;
798fe835674SShri Abhyankar     else nloc_isact++;
799d950fb63SShri Abhyankar   }
800d950fb63SShri Abhyankar   ierr = PetscMalloc(nloc_isact*sizeof(PetscInt),&idx_act);CHKERRQ(ierr);
801d950fb63SShri Abhyankar   ierr = PetscMalloc(nloc_isinact*sizeof(PetscInt),&idx_inact);CHKERRQ(ierr);
802d950fb63SShri Abhyankar 
803d950fb63SShri Abhyankar   /* Creating the indexing arrays */
804d950fb63SShri Abhyankar   for(i=0; i < nlocal; i++) {
805fe835674SShri Abhyankar     if (((x[i] > xl[i] + 1.e-8 || (f[i] < 0.0)) && ((x[i] < xu[i] - 1.e-8) || f[i] > 0.0))) idx_inact[i2++] = ilow+i;
806fe835674SShri Abhyankar     else idx_act[i1++] = ilow+i;
807d950fb63SShri Abhyankar   }
808d950fb63SShri Abhyankar 
809d950fb63SShri Abhyankar   /* Create the index sets */
810d950fb63SShri Abhyankar   ierr = ISCreateGeneral(((PetscObject)snes)->comm,nloc_isact,idx_act,PETSC_COPY_VALUES,ISact);CHKERRQ(ierr);
811d950fb63SShri Abhyankar   ierr = ISCreateGeneral(((PetscObject)snes)->comm,nloc_isinact,idx_inact,PETSC_COPY_VALUES,ISinact);CHKERRQ(ierr);
812d950fb63SShri Abhyankar 
813fe835674SShri Abhyankar   ierr = VecRestoreArrayRead(X,&x);CHKERRQ(ierr);
814fe835674SShri Abhyankar   ierr = VecRestoreArrayRead(Xl,&xl);CHKERRQ(ierr);
815fe835674SShri Abhyankar   ierr = VecRestoreArrayRead(Xu,&xu);CHKERRQ(ierr);
816fe835674SShri Abhyankar   ierr = VecRestoreArrayRead(F,&f);CHKERRQ(ierr);
817d950fb63SShri Abhyankar   ierr = PetscFree(idx_act);CHKERRQ(ierr);
818d950fb63SShri Abhyankar   ierr = PetscFree(idx_inact);CHKERRQ(ierr);
819d950fb63SShri Abhyankar   PetscFunctionReturn(0);
820d950fb63SShri Abhyankar }
821d950fb63SShri Abhyankar 
822dbd914b8SShri Abhyankar /* Create active and inactive set vectors. The local size of this vector is set and petsc computes the global size */
823dbd914b8SShri Abhyankar #undef __FUNCT__
824fe835674SShri Abhyankar #define __FUNCT__ "SNESVICreateSubVectors"
825fe835674SShri Abhyankar PetscErrorCode SNESVICreateSubVectors(SNES snes,PetscInt n,Vec* newv)
826dbd914b8SShri Abhyankar {
827dbd914b8SShri Abhyankar   PetscErrorCode ierr;
828dbd914b8SShri Abhyankar   Vec            v;
829dbd914b8SShri Abhyankar 
830dbd914b8SShri Abhyankar   PetscFunctionBegin;
831dbd914b8SShri Abhyankar   ierr = VecCreate(((PetscObject)snes)->comm,&v);CHKERRQ(ierr);
832dbd914b8SShri Abhyankar   ierr = VecSetSizes(v,n,PETSC_DECIDE);CHKERRQ(ierr);
833dbd914b8SShri Abhyankar   ierr = VecSetFromOptions(v);CHKERRQ(ierr);
834dbd914b8SShri Abhyankar   *newv = v;
835dbd914b8SShri Abhyankar 
836dbd914b8SShri Abhyankar   PetscFunctionReturn(0);
837dbd914b8SShri Abhyankar }
838dbd914b8SShri Abhyankar 
839732bb160SShri Abhyankar /* Resets the snes PC and KSP when the active set sizes change */
840732bb160SShri Abhyankar #undef __FUNCT__
841732bb160SShri Abhyankar #define __FUNCT__ "SNESVIResetPCandKSP"
842732bb160SShri Abhyankar PetscErrorCode SNESVIResetPCandKSP(SNES snes,Mat Amat,Mat Pmat)
843732bb160SShri Abhyankar {
844732bb160SShri Abhyankar   PetscErrorCode ierr;
845732bb160SShri Abhyankar   KSP kspnew,snesksp;
846732bb160SShri Abhyankar   PC  pcnew;
847732bb160SShri Abhyankar   const MatSolverPackage stype;
848dbd914b8SShri Abhyankar 
849732bb160SShri Abhyankar   PetscFunctionBegin;
850732bb160SShri Abhyankar   /* The active and inactive set sizes have changed so need to create a new snes->ksp object */
851732bb160SShri Abhyankar   ierr = SNESGetKSP(snes,&snesksp);CHKERRQ(ierr);
852732bb160SShri Abhyankar   ierr = KSPCreate(((PetscObject)snes)->comm,&kspnew);CHKERRQ(ierr);
853732bb160SShri Abhyankar   /* Copy over snes->ksp info */
854732bb160SShri Abhyankar   kspnew->pc_side = snesksp->pc_side;
855732bb160SShri Abhyankar   kspnew->rtol    = snesksp->rtol;
856732bb160SShri Abhyankar   kspnew->abstol    = snesksp->abstol;
857732bb160SShri Abhyankar   kspnew->max_it  = snesksp->max_it;
858732bb160SShri Abhyankar   ierr = KSPSetType(kspnew,((PetscObject)snesksp)->type_name);CHKERRQ(ierr);
859732bb160SShri Abhyankar   ierr = KSPGetPC(kspnew,&pcnew);CHKERRQ(ierr);
860732bb160SShri Abhyankar   ierr = PCSetType(kspnew->pc,((PetscObject)snesksp->pc)->type_name);CHKERRQ(ierr);
861732bb160SShri Abhyankar   ierr = PCSetOperators(kspnew->pc,Amat,Pmat,DIFFERENT_NONZERO_PATTERN);CHKERRQ(ierr);
862732bb160SShri Abhyankar   ierr = PCFactorGetMatSolverPackage(snesksp->pc,&stype);CHKERRQ(ierr);
863732bb160SShri Abhyankar   ierr = PCFactorSetMatSolverPackage(kspnew->pc,stype);CHKERRQ(ierr);
864732bb160SShri Abhyankar   ierr = KSPDestroy(snesksp);CHKERRQ(ierr);
865732bb160SShri Abhyankar   snes->ksp = kspnew;
866732bb160SShri Abhyankar   ierr = PetscLogObjectParent(snes,kspnew);CHKERRQ(ierr);
867732bb160SShri Abhyankar   ierr = KSPSetFromOptions(kspnew);CHKERRQ(ierr);
868732bb160SShri Abhyankar   PetscFunctionReturn(0);
869732bb160SShri Abhyankar }
87069c03620SShri Abhyankar /* Variational Inequality solver using active set method */
87169c03620SShri Abhyankar #undef __FUNCT__
87269c03620SShri Abhyankar #define __FUNCT__ "SNESSolveVI_AS"
87369c03620SShri Abhyankar PetscErrorCode SNESSolveVI_AS(SNES snes)
87469c03620SShri Abhyankar {
87569c03620SShri Abhyankar   SNES_VI          *vi = (SNES_VI*)snes->data;
87669c03620SShri Abhyankar   PetscErrorCode     ierr;
877408da460SShri Abhyankar   PetscInt           maxits,i,lits,Nis_act=0;
8783b336b49SShri Abhyankar   PetscBool         lssucceed;
87969c03620SShri Abhyankar   MatStructure       flg = DIFFERENT_NONZERO_PATTERN;
88069c03620SShri Abhyankar   PetscReal          gnorm,xnorm=0,ynorm;
88169c03620SShri Abhyankar   Vec                Y,X,F,G,W;
88269c03620SShri Abhyankar   KSPConvergedReason kspreason;
88369c03620SShri Abhyankar 
88469c03620SShri Abhyankar   PetscFunctionBegin;
88569c03620SShri Abhyankar   snes->numFailures            = 0;
88669c03620SShri Abhyankar   snes->numLinearSolveFailures = 0;
88769c03620SShri Abhyankar   snes->reason                 = SNES_CONVERGED_ITERATING;
88869c03620SShri Abhyankar 
88969c03620SShri Abhyankar   maxits	= snes->max_its;	/* maximum number of iterations */
89069c03620SShri Abhyankar   X		= snes->vec_sol;	/* solution vector */
89169c03620SShri Abhyankar   F		= snes->vec_func;	/* residual vector */
89269c03620SShri Abhyankar   Y		= snes->work[0];	/* work vectors */
89369c03620SShri Abhyankar   G		= snes->work[1];
89469c03620SShri Abhyankar   W		= snes->work[2];
89569c03620SShri Abhyankar 
89669c03620SShri Abhyankar   ierr = PetscObjectTakeAccess(snes);CHKERRQ(ierr);
89769c03620SShri Abhyankar   snes->iter = 0;
89869c03620SShri Abhyankar   snes->norm = 0.0;
89969c03620SShri Abhyankar   ierr = PetscObjectGrantAccess(snes);CHKERRQ(ierr);
90069c03620SShri Abhyankar 
90169c03620SShri Abhyankar   ierr = SNESVIAdjustInitialGuess(X,vi->xl,vi->xu);CHKERRQ(ierr);
90269c03620SShri Abhyankar   ierr = SNESComputeFunction(snes,X,vi->phi);CHKERRQ(ierr);
90369c03620SShri Abhyankar   if (snes->domainerror) {
90469c03620SShri Abhyankar     snes->reason = SNES_DIVERGED_FUNCTION_DOMAIN;
90569c03620SShri Abhyankar     PetscFunctionReturn(0);
90669c03620SShri Abhyankar   }
90769c03620SShri Abhyankar    /* Compute Merit function */
90869c03620SShri Abhyankar   ierr = SNESVIComputeMeritFunction(vi->phi,&vi->merit,&vi->phinorm);CHKERRQ(ierr);
90969c03620SShri Abhyankar 
91069c03620SShri Abhyankar   ierr = VecNormBegin(X,NORM_2,&xnorm);CHKERRQ(ierr);	/* xnorm <- ||x||  */
91169c03620SShri Abhyankar   ierr = VecNormEnd(X,NORM_2,&xnorm);CHKERRQ(ierr);
91269c03620SShri Abhyankar   if PetscIsInfOrNanReal(vi->merit) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FP,"User provided compute function generated a Not-a-Number");
91369c03620SShri Abhyankar 
91469c03620SShri Abhyankar   ierr = PetscObjectTakeAccess(snes);CHKERRQ(ierr);
91569c03620SShri Abhyankar   snes->norm = vi->phinorm;
91669c03620SShri Abhyankar   ierr = PetscObjectGrantAccess(snes);CHKERRQ(ierr);
91769c03620SShri Abhyankar   SNESLogConvHistory(snes,vi->phinorm,0);
91869c03620SShri Abhyankar   SNESMonitor(snes,0,vi->phinorm);
91969c03620SShri Abhyankar 
92069c03620SShri Abhyankar   /* set parameter for default relative tolerance convergence test */
92169c03620SShri Abhyankar   snes->ttol = vi->phinorm*snes->rtol;
92269c03620SShri Abhyankar   /* test convergence */
92369c03620SShri Abhyankar   ierr = (*snes->ops->converged)(snes,0,0.0,0.0,vi->phinorm,&snes->reason,snes->cnvP);CHKERRQ(ierr);
92469c03620SShri Abhyankar   if (snes->reason) PetscFunctionReturn(0);
92569c03620SShri Abhyankar 
92669c03620SShri Abhyankar   for (i=0; i<maxits; i++) {
92769c03620SShri Abhyankar 
928a79edbefSShri Abhyankar     IS                 IS_act,IS_inact; /* _act -> active set _inact -> inactive set */
929a79edbefSShri Abhyankar     PetscReal          thresh,J_norm1;
930dbd914b8SShri Abhyankar     VecScatter         scat_act,scat_inact;
931408da460SShri Abhyankar     PetscInt           nis_act,nis_inact,Nis_act_prev;
932dbd914b8SShri Abhyankar     Vec                Da_act,Da_inact,Db_inact;
933dbd914b8SShri Abhyankar     Vec                Y_act,Y_inact,phi_act,phi_inact;
934d76c674bSShri Abhyankar     Mat                jac_inact_inact,jac_inact_act,prejac_inact_inact;
935a79edbefSShri Abhyankar 
93669c03620SShri Abhyankar     /* Call general purpose update function */
93769c03620SShri Abhyankar     if (snes->ops->update) {
93869c03620SShri Abhyankar       ierr = (*snes->ops->update)(snes, snes->iter);CHKERRQ(ierr);
93969c03620SShri Abhyankar     }
94069c03620SShri Abhyankar     ierr = SNESComputeJacobian(snes,X,&snes->jacobian,&snes->jacobian_pre,&flg);CHKERRQ(ierr);
94169c03620SShri Abhyankar     /* Compute the threshold value for creating active and inactive sets */
94269c03620SShri Abhyankar     ierr = MatNorm(snes->jacobian,NORM_1,&J_norm1);CHKERRQ(ierr);
94369c03620SShri Abhyankar     thresh = PetscMin(vi->merit,1e-2)/(1+J_norm1);
944a79edbefSShri Abhyankar 
945a79edbefSShri Abhyankar     /* Compute B-subdifferential vectors Da and Db */
946a79edbefSShri Abhyankar     ierr = SNESVIComputeBsubdifferentialVectors(snes,X,F,snes->jacobian,vi->Da,vi->Db);CHKERRQ(ierr);
947dbd914b8SShri Abhyankar 
94869c03620SShri Abhyankar     /* Create active and inactive index sets */
94969c03620SShri Abhyankar     ierr = SNESVICreateIndexSets_AS(snes,vi->Db,thresh,&IS_act,&IS_inact);CHKERRQ(ierr);
95069c03620SShri Abhyankar 
951408da460SShri Abhyankar     Nis_act_prev = Nis_act;
952408da460SShri Abhyankar     /* Get sizes of active and inactive sets */
953dbd914b8SShri Abhyankar     ierr = ISGetLocalSize(IS_act,&nis_act);CHKERRQ(ierr);
954dbd914b8SShri Abhyankar     ierr = ISGetLocalSize(IS_inact,&nis_inact);CHKERRQ(ierr);
955408da460SShri Abhyankar     ierr = ISGetSize(IS_act,&Nis_act);CHKERRQ(ierr);
956dbd914b8SShri Abhyankar 
957d76c674bSShri Abhyankar     ierr = PetscPrintf(PETSC_COMM_WORLD,"Size of active set = %d, size of inactive set = %d\n",nis_act,nis_inact);CHKERRQ(ierr);
958d76c674bSShri Abhyankar 
959dbd914b8SShri Abhyankar     /* Create active and inactive set vectors */
960fe835674SShri Abhyankar     ierr = SNESVICreateSubVectors(snes,nis_act,&Da_act);CHKERRQ(ierr);
961fe835674SShri Abhyankar     ierr = SNESVICreateSubVectors(snes,nis_inact,&Da_inact);CHKERRQ(ierr);
962fe835674SShri Abhyankar     ierr = SNESVICreateSubVectors(snes,nis_inact,&Db_inact);CHKERRQ(ierr);
963fe835674SShri Abhyankar     ierr = SNESVICreateSubVectors(snes,nis_act,&phi_act);CHKERRQ(ierr);
964fe835674SShri Abhyankar     ierr = SNESVICreateSubVectors(snes,nis_inact,&phi_inact);CHKERRQ(ierr);
965fe835674SShri Abhyankar     ierr = SNESVICreateSubVectors(snes,nis_act,&Y_act);CHKERRQ(ierr);
966fe835674SShri Abhyankar     ierr = SNESVICreateSubVectors(snes,nis_inact,&Y_inact);CHKERRQ(ierr);
967dbd914b8SShri Abhyankar 
968dbd914b8SShri Abhyankar     /* Create inactive set submatrices */
969dbd914b8SShri Abhyankar     ierr = MatGetSubMatrix(snes->jacobian,IS_inact,IS_act,MAT_INITIAL_MATRIX,&jac_inact_act);CHKERRQ(ierr);
970dbd914b8SShri Abhyankar     ierr = MatGetSubMatrix(snes->jacobian,IS_inact,IS_inact,MAT_INITIAL_MATRIX,&jac_inact_inact);CHKERRQ(ierr);
971dbd914b8SShri Abhyankar 
972dbd914b8SShri Abhyankar     /* Create scatter contexts */
973dbd914b8SShri Abhyankar     ierr = VecScatterCreate(vi->Da,IS_act,Da_act,PETSC_NULL,&scat_act);CHKERRQ(ierr);
974dbd914b8SShri Abhyankar     ierr = VecScatterCreate(vi->Da,IS_inact,Da_inact,PETSC_NULL,&scat_inact);CHKERRQ(ierr);
975dbd914b8SShri Abhyankar 
976dbd914b8SShri Abhyankar     /* Do a vec scatter to active and inactive set vectors */
977dbd914b8SShri Abhyankar     ierr = VecScatterBegin(scat_act,vi->Da,Da_act,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
978dbd914b8SShri Abhyankar     ierr = VecScatterEnd(scat_act,vi->Da,Da_act,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
979dbd914b8SShri Abhyankar 
980dbd914b8SShri Abhyankar     ierr = VecScatterBegin(scat_inact,vi->Da,Da_inact,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
981dbd914b8SShri Abhyankar     ierr = VecScatterEnd(scat_inact,vi->Da,Da_inact,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
982dbd914b8SShri Abhyankar 
983dbd914b8SShri Abhyankar     ierr = VecScatterBegin(scat_inact,vi->Db,Db_inact,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
984dbd914b8SShri Abhyankar     ierr = VecScatterEnd(scat_inact,vi->Db,Db_inact,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
985dbd914b8SShri Abhyankar 
986dbd914b8SShri Abhyankar     ierr = VecScatterBegin(scat_act,vi->phi,phi_act,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
987dbd914b8SShri Abhyankar     ierr = VecScatterEnd(scat_act,vi->phi,phi_act,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
988dbd914b8SShri Abhyankar 
989dbd914b8SShri Abhyankar     ierr = VecScatterBegin(scat_inact,vi->phi,phi_inact,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
990dbd914b8SShri Abhyankar     ierr = VecScatterEnd(scat_inact,vi->phi,phi_inact,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
991dbd914b8SShri Abhyankar 
992dbd914b8SShri Abhyankar     ierr = VecScatterBegin(scat_act,Y,Y_act,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
993dbd914b8SShri Abhyankar     ierr = VecScatterEnd(scat_act,Y,Y_act,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
994dbd914b8SShri Abhyankar 
995dbd914b8SShri Abhyankar     ierr = VecScatterBegin(scat_inact,Y,Y_inact,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
996dbd914b8SShri Abhyankar     ierr = VecScatterEnd(scat_inact,Y,Y_inact,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
997dbd914b8SShri Abhyankar 
998dbd914b8SShri Abhyankar     /* Active set direction */
999dbd914b8SShri Abhyankar     ierr = VecPointwiseDivide(Y_act,phi_act,Da_act);CHKERRQ(ierr);
1000d76c674bSShri Abhyankar     /* inactive set jacobian and preconditioner */
1001dbd914b8SShri Abhyankar     ierr = VecPointwiseDivide(Da_inact,Da_inact,Db_inact);CHKERRQ(ierr);
1002dbd914b8SShri Abhyankar     ierr = MatDiagonalSet(jac_inact_inact,Da_inact,ADD_VALUES);CHKERRQ(ierr);
1003d76c674bSShri Abhyankar     if (snes->jacobian != snes->jacobian_pre) {
1004d76c674bSShri Abhyankar       ierr = MatGetSubMatrix(snes->jacobian_pre,IS_inact,IS_inact,MAT_INITIAL_MATRIX,&prejac_inact_inact);CHKERRQ(ierr);
1005d76c674bSShri Abhyankar       ierr = MatDiagonalSet(prejac_inact_inact,Da_inact,ADD_VALUES);CHKERRQ(ierr);
1006d76c674bSShri Abhyankar     } else prejac_inact_inact = jac_inact_inact;
1007d76c674bSShri Abhyankar 
1008dbd914b8SShri Abhyankar     /* right hand side */
1009dbd914b8SShri Abhyankar     ierr = VecPointwiseDivide(phi_inact,phi_inact,Db_inact);CHKERRQ(ierr);
1010dbd914b8SShri Abhyankar     ierr = MatMult(jac_inact_act,Y_act,Db_inact);CHKERRQ(ierr);
1011dbd914b8SShri Abhyankar     ierr = VecAXPY(phi_inact,-1.0,Db_inact);CHKERRQ(ierr);
1012dbd914b8SShri Abhyankar 
1013408da460SShri Abhyankar     if ((i != 0) && (Nis_act != Nis_act_prev)) {
1014732bb160SShri Abhyankar       ierr = SNESVIResetPCandKSP(snes,jac_inact_inact,prejac_inact_inact);CHKERRQ(ierr);
1015408da460SShri Abhyankar     }
1016408da460SShri Abhyankar 
1017d76c674bSShri Abhyankar     ierr = KSPSetOperators(snes->ksp,jac_inact_inact,prejac_inact_inact,flg);CHKERRQ(ierr);
1018dbd914b8SShri Abhyankar     ierr = SNES_KSPSolve(snes,snes->ksp,phi_inact,Y_inact);CHKERRQ(ierr);
1019dbd914b8SShri Abhyankar     ierr = KSPGetConvergedReason(snes->ksp,&kspreason);CHKERRQ(ierr);
10203b336b49SShri Abhyankar     if (kspreason < 0) {
10213b336b49SShri Abhyankar       if (++snes->numLinearSolveFailures >= snes->maxLinearSolveFailures) {
10223b336b49SShri 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);
10233b336b49SShri Abhyankar         snes->reason = SNES_DIVERGED_LINEAR_SOLVE;
10243b336b49SShri Abhyankar         break;
10253b336b49SShri Abhyankar       }
10263b336b49SShri Abhyankar      }
1027dbd914b8SShri Abhyankar 
1028dbd914b8SShri Abhyankar     ierr = VecScatterBegin(scat_act,Y_act,Y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1029dbd914b8SShri Abhyankar     ierr = VecScatterEnd(scat_act,Y_act,Y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1030dbd914b8SShri Abhyankar     ierr = VecScatterBegin(scat_inact,Y_inact,Y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1031dbd914b8SShri Abhyankar     ierr = VecScatterEnd(scat_inact,Y_inact,Y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1032dbd914b8SShri Abhyankar 
1033dbd914b8SShri Abhyankar     ierr = VecDestroy(Da_act);CHKERRQ(ierr);
1034dbd914b8SShri Abhyankar     ierr = VecDestroy(Da_inact);CHKERRQ(ierr);
1035dbd914b8SShri Abhyankar     ierr = VecDestroy(Db_inact);CHKERRQ(ierr);
1036dbd914b8SShri Abhyankar     ierr = VecDestroy(phi_act);CHKERRQ(ierr);
1037dbd914b8SShri Abhyankar     ierr = VecDestroy(phi_inact);CHKERRQ(ierr);
1038dbd914b8SShri Abhyankar     ierr = VecDestroy(Y_act);CHKERRQ(ierr);
1039dbd914b8SShri Abhyankar     ierr = VecDestroy(Y_inact);CHKERRQ(ierr);
1040dbd914b8SShri Abhyankar     ierr = VecScatterDestroy(scat_act);CHKERRQ(ierr);
1041dbd914b8SShri Abhyankar     ierr = VecScatterDestroy(scat_inact);CHKERRQ(ierr);
1042730c24dcSShri Abhyankar     ierr = ISDestroy(IS_act);CHKERRQ(ierr);
1043730c24dcSShri Abhyankar     ierr = ISDestroy(IS_inact);CHKERRQ(ierr);
1044bac2f86eSShri Abhyankar     ierr = MatDestroy(jac_inact_act);CHKERRQ(ierr);
1045bac2f86eSShri Abhyankar     ierr = MatDestroy(jac_inact_inact);CHKERRQ(ierr);
1046d76c674bSShri Abhyankar     if (snes->jacobian != snes->jacobian_pre) {
1047d76c674bSShri Abhyankar       ierr = MatDestroy(prejac_inact_inact);CHKERRQ(ierr);
1048d76c674bSShri Abhyankar     }
1049730c24dcSShri Abhyankar 
105069c03620SShri Abhyankar     ierr = KSPGetIterationNumber(snes->ksp,&lits);CHKERRQ(ierr);
105169c03620SShri Abhyankar     snes->linear_its += lits;
105269c03620SShri Abhyankar     ierr = PetscInfo2(snes,"iter=%D, linear solve iterations=%D\n",snes->iter,lits);CHKERRQ(ierr);
105369c03620SShri Abhyankar     /*
105469c03620SShri Abhyankar     if (vi->precheckstep) {
105569c03620SShri Abhyankar       PetscBool changed_y = PETSC_FALSE;
105669c03620SShri Abhyankar       ierr = (*vi->precheckstep)(snes,X,Y,vi->precheck,&changed_y);CHKERRQ(ierr);
105769c03620SShri Abhyankar     }
105869c03620SShri Abhyankar 
105969c03620SShri Abhyankar     if (PetscLogPrintInfo){
106069c03620SShri Abhyankar       ierr = SNESVICheckResidual_Private(snes,snes->jacobian,F,Y,G,W);CHKERRQ(ierr);
106169c03620SShri Abhyankar     }
106269c03620SShri Abhyankar     */
106369c03620SShri Abhyankar     /* Compute a (scaled) negative update in the line search routine:
106469c03620SShri Abhyankar          Y <- X - lambda*Y
106569c03620SShri Abhyankar        and evaluate G = function(Y) (depends on the line search).
106669c03620SShri Abhyankar     */
106769c03620SShri Abhyankar     ierr = VecCopy(Y,snes->vec_sol_update);CHKERRQ(ierr);
106869c03620SShri Abhyankar     ynorm = 1; gnorm = vi->phinorm;
10693b336b49SShri Abhyankar     ierr = SNESVIComputeJacobian(snes->jacobian,snes->jacobian_pre,vi->Da,vi->Db);CHKERRQ(ierr);
1070ee657d29SShri Abhyankar     ierr = SNESVIComputeMeritFunctionGradient(snes->jacobian,vi->phi,vi->dpsi);CHKERRQ(ierr);
107169c03620SShri Abhyankar     ierr = (*vi->LineSearch)(snes,vi->lsP,X,vi->phi,G,Y,W,vi->phinorm,xnorm,&ynorm,&gnorm,&lssucceed);CHKERRQ(ierr);
107269c03620SShri Abhyankar     ierr = PetscInfo4(snes,"fnorm=%18.16e, gnorm=%18.16e, ynorm=%18.16e, lssucceed=%d\n",vi->phinorm,gnorm,ynorm,(int)lssucceed);CHKERRQ(ierr);
107369c03620SShri Abhyankar     if (snes->reason == SNES_DIVERGED_FUNCTION_COUNT) break;
107469c03620SShri Abhyankar     if (snes->domainerror) {
107569c03620SShri Abhyankar       snes->reason = SNES_DIVERGED_FUNCTION_DOMAIN;
107669c03620SShri Abhyankar       PetscFunctionReturn(0);
107769c03620SShri Abhyankar     }
107869c03620SShri Abhyankar     if (!lssucceed) {
107969c03620SShri Abhyankar       if (++snes->numFailures >= snes->maxFailures) {
108069c03620SShri Abhyankar 	PetscBool ismin;
108169c03620SShri Abhyankar         snes->reason = SNES_DIVERGED_LINE_SEARCH;
108269c03620SShri Abhyankar         ierr = SNESVICheckLocalMin_Private(snes,snes->jacobian,G,W,gnorm,&ismin);CHKERRQ(ierr);
108369c03620SShri Abhyankar         if (ismin) snes->reason = SNES_DIVERGED_LOCAL_MIN;
108469c03620SShri Abhyankar         break;
108569c03620SShri Abhyankar       }
108669c03620SShri Abhyankar     }
108769c03620SShri Abhyankar     /* Update function and solution vectors */
108869c03620SShri Abhyankar     vi->phinorm = gnorm;
108969c03620SShri Abhyankar     vi->merit = 0.5*vi->phinorm*vi->phinorm;
109069c03620SShri Abhyankar     ierr = VecCopy(G,vi->phi);CHKERRQ(ierr);
109169c03620SShri Abhyankar     ierr = VecCopy(W,X);CHKERRQ(ierr);
109269c03620SShri Abhyankar     /* Monitor convergence */
109369c03620SShri Abhyankar     ierr = PetscObjectTakeAccess(snes);CHKERRQ(ierr);
109469c03620SShri Abhyankar     snes->iter = i+1;
109569c03620SShri Abhyankar     snes->norm = vi->phinorm;
109669c03620SShri Abhyankar     ierr = PetscObjectGrantAccess(snes);CHKERRQ(ierr);
109769c03620SShri Abhyankar     SNESLogConvHistory(snes,snes->norm,lits);
109869c03620SShri Abhyankar     SNESMonitor(snes,snes->iter,snes->norm);
109969c03620SShri Abhyankar     /* Test for convergence, xnorm = || X || */
110069c03620SShri Abhyankar     if (snes->ops->converged != SNESSkipConverged) { ierr = VecNorm(X,NORM_2,&xnorm);CHKERRQ(ierr); }
110169c03620SShri Abhyankar     ierr = (*snes->ops->converged)(snes,snes->iter,xnorm,ynorm,vi->phinorm,&snes->reason,snes->cnvP);CHKERRQ(ierr);
110269c03620SShri Abhyankar     if (snes->reason) break;
110369c03620SShri Abhyankar   }
110469c03620SShri Abhyankar   if (i == maxits) {
110569c03620SShri Abhyankar     ierr = PetscInfo1(snes,"Maximum number of iterations has been reached: %D\n",maxits);CHKERRQ(ierr);
110669c03620SShri Abhyankar     if(!snes->reason) snes->reason = SNES_DIVERGED_MAX_IT;
110769c03620SShri Abhyankar   }
110869c03620SShri Abhyankar   PetscFunctionReturn(0);
110969c03620SShri Abhyankar }
111069c03620SShri Abhyankar 
1111fe835674SShri Abhyankar #undef __FUNCT__
1112fe835674SShri Abhyankar #define __FUNCT__ "SNESVIComputeInactiveSetFnorm"
1113fe835674SShri Abhyankar PetscErrorCode SNESVIComputeInactiveSetFnorm(SNES snes,Vec F,Vec X,PetscScalar *fnorm)
1114fe835674SShri Abhyankar {
1115fe835674SShri Abhyankar   PetscErrorCode    ierr;
1116fe835674SShri Abhyankar   SNES_VI           *vi = (SNES_VI*)snes->data;
1117fe835674SShri Abhyankar   const PetscScalar *x,*xl,*xu,*f;
1118fe835674SShri Abhyankar   PetscInt          i,n;
1119fe835674SShri Abhyankar   PetscReal         rnorm;
1120fe835674SShri Abhyankar 
1121fe835674SShri Abhyankar   PetscFunctionBegin;
1122fe835674SShri Abhyankar 
1123fe835674SShri Abhyankar   ierr = VecGetLocalSize(X,&n);CHKERRQ(ierr);
1124fe835674SShri Abhyankar   ierr = VecGetArrayRead(vi->xl,&xl);CHKERRQ(ierr);
1125fe835674SShri Abhyankar   ierr = VecGetArrayRead(vi->xu,&xu);CHKERRQ(ierr);
1126fe835674SShri Abhyankar   ierr = VecGetArrayRead(X,&x);CHKERRQ(ierr);
1127fe835674SShri Abhyankar   ierr = VecGetArrayRead(F,&f);CHKERRQ(ierr);
1128fe835674SShri Abhyankar 
1129fe835674SShri Abhyankar   rnorm = 0.0;
1130fe835674SShri Abhyankar   for (i=0; i<n; i++) {
1131fe835674SShri Abhyankar     if (((x[i] > xl[i] + 1.e-8 || (f[i] < 0.0)) && ((x[i] < xu[i] - 1.e-8) || f[i] > 0.0))) rnorm += f[i]*f[i];
1132fe835674SShri Abhyankar   }
1133fe835674SShri Abhyankar   ierr = VecRestoreArrayRead(F,&f);CHKERRQ(ierr);
1134fe835674SShri Abhyankar   ierr = VecRestoreArrayRead(vi->xl,&xl);CHKERRQ(ierr);
1135fe835674SShri Abhyankar   ierr = VecRestoreArrayRead(vi->xu,&xu);CHKERRQ(ierr);
1136fe835674SShri Abhyankar   ierr = VecRestoreArrayRead(X,&x);CHKERRQ(ierr);
1137fe835674SShri Abhyankar   ierr = MPI_Allreduce(&rnorm,fnorm,1,MPIU_REAL,MPI_SUM,((PetscObject)snes)->comm);CHKERRQ(ierr);
1138fe835674SShri Abhyankar   *fnorm = sqrt(*fnorm);
1139fe835674SShri Abhyankar   PetscFunctionReturn(0);
1140fe835674SShri Abhyankar }
1141fe835674SShri Abhyankar 
1142fe835674SShri Abhyankar /* Variational Inequality solver using reduce space method. No semismooth algorithm is
1143fe835674SShri Abhyankar    implemented in this algorithm. It basically identifies the active variables and does
1144fe835674SShri Abhyankar    a linear solve on the inactive variables. */
1145d950fb63SShri Abhyankar #undef __FUNCT__
1146d950fb63SShri Abhyankar #define __FUNCT__ "SNESSolveVI_RS"
1147d950fb63SShri Abhyankar PetscErrorCode SNESSolveVI_RS(SNES snes)
1148d950fb63SShri Abhyankar {
1149d950fb63SShri Abhyankar   SNES_VI          *vi = (SNES_VI*)snes->data;
1150d950fb63SShri Abhyankar   PetscErrorCode    ierr;
115164221577SShri Abhyankar   PetscInt          maxits,i,lits,Nis_inact;
1152d950fb63SShri Abhyankar   PetscBool         lssucceed;
1153d950fb63SShri Abhyankar   MatStructure      flg = DIFFERENT_NONZERO_PATTERN;
1154fe835674SShri Abhyankar   PetscReal         fnorm,gnorm,xnorm=0,ynorm;
1155d950fb63SShri Abhyankar   Vec                Y,X,F,G,W;
1156d950fb63SShri Abhyankar   KSPConvergedReason kspreason;
1157d950fb63SShri Abhyankar 
1158d950fb63SShri Abhyankar   PetscFunctionBegin;
1159d950fb63SShri Abhyankar   snes->numFailures            = 0;
1160d950fb63SShri Abhyankar   snes->numLinearSolveFailures = 0;
1161d950fb63SShri Abhyankar   snes->reason                 = SNES_CONVERGED_ITERATING;
1162d950fb63SShri Abhyankar 
1163d950fb63SShri Abhyankar   maxits	= snes->max_its;	/* maximum number of iterations */
1164d950fb63SShri Abhyankar   X		= snes->vec_sol;	/* solution vector */
1165d950fb63SShri Abhyankar   F		= snes->vec_func;	/* residual vector */
1166d950fb63SShri Abhyankar   Y		= snes->work[0];	/* work vectors */
1167d950fb63SShri Abhyankar   G		= snes->work[1];
1168d950fb63SShri Abhyankar   W		= snes->work[2];
1169d950fb63SShri Abhyankar 
117064221577SShri Abhyankar   Nis_inact = F->map->N;
1171d950fb63SShri Abhyankar   ierr = PetscObjectTakeAccess(snes);CHKERRQ(ierr);
1172d950fb63SShri Abhyankar   snes->iter = 0;
1173d950fb63SShri Abhyankar   snes->norm = 0.0;
1174d950fb63SShri Abhyankar   ierr = PetscObjectGrantAccess(snes);CHKERRQ(ierr);
1175d950fb63SShri Abhyankar 
1176d950fb63SShri Abhyankar   ierr = SNESVIAdjustInitialGuess(X,vi->xl,vi->xu);CHKERRQ(ierr);
1177fe835674SShri Abhyankar   ierr = SNESComputeFunction(snes,X,F);CHKERRQ(ierr);
1178d950fb63SShri Abhyankar   if (snes->domainerror) {
1179d950fb63SShri Abhyankar     snes->reason = SNES_DIVERGED_FUNCTION_DOMAIN;
1180d950fb63SShri Abhyankar     PetscFunctionReturn(0);
1181d950fb63SShri Abhyankar   }
1182fe835674SShri Abhyankar   ierr = SNESVIComputeInactiveSetFnorm(snes,F,X,&fnorm);CHKERRQ(ierr);
1183d950fb63SShri Abhyankar   ierr = VecNormBegin(X,NORM_2,&xnorm);CHKERRQ(ierr);	/* xnorm <- ||x||  */
1184d950fb63SShri Abhyankar   ierr = VecNormEnd(X,NORM_2,&xnorm);CHKERRQ(ierr);
1185fe835674SShri Abhyankar   if PetscIsInfOrNanReal(fnorm) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FP,"User provided compute function generated a Not-a-Number");
1186d950fb63SShri Abhyankar 
1187d950fb63SShri Abhyankar   ierr = PetscObjectTakeAccess(snes);CHKERRQ(ierr);
1188fe835674SShri Abhyankar   snes->norm = fnorm;
1189d950fb63SShri Abhyankar   ierr = PetscObjectGrantAccess(snes);CHKERRQ(ierr);
1190fe835674SShri Abhyankar   SNESLogConvHistory(snes,fnorm,0);
1191fe835674SShri Abhyankar   SNESMonitor(snes,0,fnorm);
1192d950fb63SShri Abhyankar 
1193d950fb63SShri Abhyankar   /* set parameter for default relative tolerance convergence test */
1194fe835674SShri Abhyankar   snes->ttol = fnorm*snes->rtol;
1195d950fb63SShri Abhyankar   /* test convergence */
1196fe835674SShri Abhyankar   ierr = (*snes->ops->converged)(snes,0,0.0,0.0,fnorm,&snes->reason,snes->cnvP);CHKERRQ(ierr);
1197d950fb63SShri Abhyankar   if (snes->reason) PetscFunctionReturn(0);
1198d950fb63SShri Abhyankar 
1199d950fb63SShri Abhyankar   for (i=0; i<maxits; i++) {
1200d950fb63SShri Abhyankar 
1201d950fb63SShri Abhyankar     IS                 IS_act,IS_inact; /* _act -> active set _inact -> inactive set */
1202d950fb63SShri Abhyankar     VecScatter         scat_act,scat_inact;
120364221577SShri Abhyankar     PetscInt           nis_act,nis_inact,Nis_inact_prev;
1204fe835674SShri Abhyankar     Vec                Y_act,Y_inact,F_inact;
1205d950fb63SShri Abhyankar     Mat                jac_inact_inact,prejac_inact_inact;
1206d950fb63SShri Abhyankar 
1207d950fb63SShri Abhyankar     /* Call general purpose update function */
1208d950fb63SShri Abhyankar     if (snes->ops->update) {
1209d950fb63SShri Abhyankar       ierr = (*snes->ops->update)(snes, snes->iter);CHKERRQ(ierr);
1210d950fb63SShri Abhyankar     }
1211d950fb63SShri Abhyankar     ierr = SNESComputeJacobian(snes,X,&snes->jacobian,&snes->jacobian_pre,&flg);CHKERRQ(ierr);
1212d950fb63SShri Abhyankar     /* Create active and inactive index sets */
1213d950fb63SShri Abhyankar     ierr = SNESVICreateIndexSets_RS(snes,X,vi->xl,vi->xu,&IS_act,&IS_inact);CHKERRQ(ierr);
1214d950fb63SShri Abhyankar 
121564221577SShri Abhyankar     Nis_inact_prev = Nis_inact;
1216d950fb63SShri Abhyankar     /* Get sizes of active and inactive sets */
1217d950fb63SShri Abhyankar     ierr = ISGetLocalSize(IS_act,&nis_act);CHKERRQ(ierr);
1218d950fb63SShri Abhyankar     ierr = ISGetLocalSize(IS_inact,&nis_inact);CHKERRQ(ierr);
121964221577SShri Abhyankar     ierr = ISGetSize(IS_inact,&Nis_inact);CHKERRQ(ierr);
1220d950fb63SShri Abhyankar 
1221d950fb63SShri Abhyankar     ierr = PetscPrintf(PETSC_COMM_WORLD,"Size of active set = %d, size of inactive set = %d\n",nis_act,nis_inact);CHKERRQ(ierr);
1222d950fb63SShri Abhyankar 
1223d950fb63SShri Abhyankar     /* Create active and inactive set vectors */
1224fe835674SShri Abhyankar     ierr = SNESVICreateSubVectors(snes,nis_inact,&F_inact);CHKERRQ(ierr);
1225fe835674SShri Abhyankar     ierr = SNESVICreateSubVectors(snes,nis_act,&Y_act);CHKERRQ(ierr);
1226fe835674SShri Abhyankar     ierr = SNESVICreateSubVectors(snes,nis_inact,&Y_inact);CHKERRQ(ierr);
1227d950fb63SShri Abhyankar 
1228d950fb63SShri Abhyankar     /* Create inactive set submatrices */
1229d950fb63SShri Abhyankar     ierr = MatGetSubMatrix(snes->jacobian,IS_inact,IS_inact,MAT_INITIAL_MATRIX,&jac_inact_inact);CHKERRQ(ierr);
1230d950fb63SShri Abhyankar 
1231d950fb63SShri Abhyankar     /* Create scatter contexts */
1232d950fb63SShri Abhyankar     ierr = VecScatterCreate(Y,IS_act,Y_act,PETSC_NULL,&scat_act);CHKERRQ(ierr);
1233d950fb63SShri Abhyankar     ierr = VecScatterCreate(Y,IS_inact,Y_inact,PETSC_NULL,&scat_inact);CHKERRQ(ierr);
1234d950fb63SShri Abhyankar 
1235d950fb63SShri Abhyankar     /* Do a vec scatter to active and inactive set vectors */
1236fe835674SShri Abhyankar     ierr = VecScatterBegin(scat_inact,F,F_inact,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1237fe835674SShri Abhyankar     ierr = VecScatterEnd(scat_inact,F,F_inact,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1238d950fb63SShri Abhyankar 
1239d950fb63SShri Abhyankar     ierr = VecScatterBegin(scat_act,Y,Y_act,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1240d950fb63SShri Abhyankar     ierr = VecScatterEnd(scat_act,Y,Y_act,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1241d950fb63SShri Abhyankar 
1242d950fb63SShri Abhyankar     ierr = VecScatterBegin(scat_inact,Y,Y_inact,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1243d950fb63SShri Abhyankar     ierr = VecScatterEnd(scat_inact,Y,Y_inact,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1244d950fb63SShri Abhyankar 
1245d950fb63SShri Abhyankar     /* Active set direction = 0 */
1246d950fb63SShri Abhyankar     ierr = VecSet(Y_act,0);CHKERRQ(ierr);
1247d950fb63SShri Abhyankar     if (snes->jacobian != snes->jacobian_pre) {
1248d950fb63SShri Abhyankar       ierr = MatGetSubMatrix(snes->jacobian_pre,IS_inact,IS_inact,MAT_INITIAL_MATRIX,&prejac_inact_inact);CHKERRQ(ierr);
1249d950fb63SShri Abhyankar     } else prejac_inact_inact = jac_inact_inact;
1250d950fb63SShri Abhyankar 
125164221577SShri Abhyankar     if (Nis_inact != Nis_inact_prev) {
1252732bb160SShri Abhyankar       ierr = SNESVIResetPCandKSP(snes,jac_inact_inact,prejac_inact_inact);CHKERRQ(ierr);
1253d950fb63SShri Abhyankar     }
1254d950fb63SShri Abhyankar 
1255d950fb63SShri Abhyankar     ierr = KSPSetOperators(snes->ksp,jac_inact_inact,prejac_inact_inact,flg);CHKERRQ(ierr);
1256fe835674SShri Abhyankar     ierr = SNES_KSPSolve(snes,snes->ksp,F_inact,Y_inact);CHKERRQ(ierr);
1257d950fb63SShri Abhyankar     ierr = KSPGetConvergedReason(snes->ksp,&kspreason);CHKERRQ(ierr);
1258d950fb63SShri Abhyankar     if (kspreason < 0) {
1259d950fb63SShri Abhyankar       if (++snes->numLinearSolveFailures >= snes->maxLinearSolveFailures) {
1260d950fb63SShri 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);
1261d950fb63SShri Abhyankar         snes->reason = SNES_DIVERGED_LINEAR_SOLVE;
1262d950fb63SShri Abhyankar         break;
1263d950fb63SShri Abhyankar       }
1264d950fb63SShri Abhyankar      }
1265d950fb63SShri Abhyankar 
1266d950fb63SShri Abhyankar     ierr = VecScatterBegin(scat_act,Y_act,Y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1267d950fb63SShri Abhyankar     ierr = VecScatterEnd(scat_act,Y_act,Y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1268d950fb63SShri Abhyankar     ierr = VecScatterBegin(scat_inact,Y_inact,Y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1269d950fb63SShri Abhyankar     ierr = VecScatterEnd(scat_inact,Y_inact,Y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1270d950fb63SShri Abhyankar 
1271fe835674SShri Abhyankar     ierr = VecDestroy(F_inact);CHKERRQ(ierr);
1272d950fb63SShri Abhyankar     ierr = VecDestroy(Y_act);CHKERRQ(ierr);
1273d950fb63SShri Abhyankar     ierr = VecDestroy(Y_inact);CHKERRQ(ierr);
1274d950fb63SShri Abhyankar     ierr = VecScatterDestroy(scat_act);CHKERRQ(ierr);
1275d950fb63SShri Abhyankar     ierr = VecScatterDestroy(scat_inact);CHKERRQ(ierr);
1276d950fb63SShri Abhyankar     ierr = ISDestroy(IS_act);CHKERRQ(ierr);
1277d950fb63SShri Abhyankar     ierr = ISDestroy(IS_inact);CHKERRQ(ierr);
1278d950fb63SShri Abhyankar     ierr = MatDestroy(jac_inact_inact);CHKERRQ(ierr);
1279d950fb63SShri Abhyankar     if (snes->jacobian != snes->jacobian_pre) {
1280d950fb63SShri Abhyankar       ierr = MatDestroy(prejac_inact_inact);CHKERRQ(ierr);
1281d950fb63SShri Abhyankar     }
1282d950fb63SShri Abhyankar 
1283d950fb63SShri Abhyankar     ierr = KSPGetIterationNumber(snes->ksp,&lits);CHKERRQ(ierr);
1284d950fb63SShri Abhyankar     snes->linear_its += lits;
1285d950fb63SShri Abhyankar     ierr = PetscInfo2(snes,"iter=%D, linear solve iterations=%D\n",snes->iter,lits);CHKERRQ(ierr);
1286d950fb63SShri Abhyankar     /*
1287d950fb63SShri Abhyankar     if (vi->precheckstep) {
1288d950fb63SShri Abhyankar       PetscBool changed_y = PETSC_FALSE;
1289d950fb63SShri Abhyankar       ierr = (*vi->precheckstep)(snes,X,Y,vi->precheck,&changed_y);CHKERRQ(ierr);
1290d950fb63SShri Abhyankar     }
1291d950fb63SShri Abhyankar 
1292d950fb63SShri Abhyankar     if (PetscLogPrintInfo){
1293d950fb63SShri Abhyankar       ierr = SNESVICheckResidual_Private(snes,snes->jacobian,F,Y,G,W);CHKERRQ(ierr);
1294d950fb63SShri Abhyankar     }
1295d950fb63SShri Abhyankar     */
1296d950fb63SShri Abhyankar     /* Compute a (scaled) negative update in the line search routine:
1297d950fb63SShri Abhyankar          Y <- X - lambda*Y
1298d950fb63SShri Abhyankar        and evaluate G = function(Y) (depends on the line search).
1299d950fb63SShri Abhyankar     */
1300d950fb63SShri Abhyankar     ierr = VecCopy(Y,snes->vec_sol_update);CHKERRQ(ierr);
1301fe835674SShri Abhyankar     ynorm = 1; gnorm = fnorm;
1302fe835674SShri Abhyankar     ierr = (*vi->LineSearch)(snes,vi->lsP,X,F,G,Y,W,fnorm,xnorm,&ynorm,&gnorm,&lssucceed);CHKERRQ(ierr);
1303fe835674SShri Abhyankar     ierr = PetscInfo4(snes,"fnorm=%18.16e, gnorm=%18.16e, ynorm=%18.16e, lssucceed=%d\n",fnorm,gnorm,ynorm,(int)lssucceed);CHKERRQ(ierr);
13042b4ed282SShri Abhyankar     if (snes->reason == SNES_DIVERGED_FUNCTION_COUNT) break;
13052b4ed282SShri Abhyankar     if (snes->domainerror) {
13062b4ed282SShri Abhyankar       snes->reason = SNES_DIVERGED_FUNCTION_DOMAIN;
13072b4ed282SShri Abhyankar       PetscFunctionReturn(0);
13082b4ed282SShri Abhyankar     }
13092b4ed282SShri Abhyankar     if (!lssucceed) {
13102b4ed282SShri Abhyankar       if (++snes->numFailures >= snes->maxFailures) {
13112b4ed282SShri Abhyankar 	PetscBool ismin;
13122b4ed282SShri Abhyankar         snes->reason = SNES_DIVERGED_LINE_SEARCH;
13132b4ed282SShri Abhyankar         ierr = SNESVICheckLocalMin_Private(snes,snes->jacobian,G,W,gnorm,&ismin);CHKERRQ(ierr);
13142b4ed282SShri Abhyankar         if (ismin) snes->reason = SNES_DIVERGED_LOCAL_MIN;
13152b4ed282SShri Abhyankar         break;
13162b4ed282SShri Abhyankar       }
13172b4ed282SShri Abhyankar     }
13182b4ed282SShri Abhyankar     /* Update function and solution vectors */
1319fe835674SShri Abhyankar     fnorm = gnorm;
1320fe835674SShri Abhyankar     ierr = VecCopy(G,F);CHKERRQ(ierr);
13212b4ed282SShri Abhyankar     ierr = VecCopy(W,X);CHKERRQ(ierr);
13222b4ed282SShri Abhyankar     /* Monitor convergence */
13232b4ed282SShri Abhyankar     ierr = PetscObjectTakeAccess(snes);CHKERRQ(ierr);
13242b4ed282SShri Abhyankar     snes->iter = i+1;
1325fe835674SShri Abhyankar     snes->norm = fnorm;
13262b4ed282SShri Abhyankar     ierr = PetscObjectGrantAccess(snes);CHKERRQ(ierr);
13272b4ed282SShri Abhyankar     SNESLogConvHistory(snes,snes->norm,lits);
13282b4ed282SShri Abhyankar     SNESMonitor(snes,snes->iter,snes->norm);
13292b4ed282SShri Abhyankar     /* Test for convergence, xnorm = || X || */
13302b4ed282SShri Abhyankar     if (snes->ops->converged != SNESSkipConverged) { ierr = VecNorm(X,NORM_2,&xnorm);CHKERRQ(ierr); }
1331fe835674SShri Abhyankar     ierr = (*snes->ops->converged)(snes,snes->iter,xnorm,ynorm,fnorm,&snes->reason,snes->cnvP);CHKERRQ(ierr);
13322b4ed282SShri Abhyankar     if (snes->reason) break;
13332b4ed282SShri Abhyankar   }
13342b4ed282SShri Abhyankar   if (i == maxits) {
13352b4ed282SShri Abhyankar     ierr = PetscInfo1(snes,"Maximum number of iterations has been reached: %D\n",maxits);CHKERRQ(ierr);
13362b4ed282SShri Abhyankar     if(!snes->reason) snes->reason = SNES_DIVERGED_MAX_IT;
13372b4ed282SShri Abhyankar   }
13382b4ed282SShri Abhyankar   PetscFunctionReturn(0);
13392b4ed282SShri Abhyankar }
13402b4ed282SShri Abhyankar 
13412b4ed282SShri Abhyankar /* -------------------------------------------------------------------------- */
13422b4ed282SShri Abhyankar /*
13432b4ed282SShri Abhyankar    SNESSetUp_VI - Sets up the internal data structures for the later use
13442b4ed282SShri Abhyankar    of the SNESVI nonlinear solver.
13452b4ed282SShri Abhyankar 
13462b4ed282SShri Abhyankar    Input Parameter:
13472b4ed282SShri Abhyankar .  snes - the SNES context
13482b4ed282SShri Abhyankar .  x - the solution vector
13492b4ed282SShri Abhyankar 
13502b4ed282SShri Abhyankar    Application Interface Routine: SNESSetUp()
13512b4ed282SShri Abhyankar 
13522b4ed282SShri Abhyankar    Notes:
13532b4ed282SShri Abhyankar    For basic use of the SNES solvers, the user need not explicitly call
13542b4ed282SShri Abhyankar    SNESSetUp(), since these actions will automatically occur during
13552b4ed282SShri Abhyankar    the call to SNESSolve().
13562b4ed282SShri Abhyankar  */
13572b4ed282SShri Abhyankar #undef __FUNCT__
13582b4ed282SShri Abhyankar #define __FUNCT__ "SNESSetUp_VI"
13592b4ed282SShri Abhyankar PetscErrorCode SNESSetUp_VI(SNES snes)
13602b4ed282SShri Abhyankar {
13612b4ed282SShri Abhyankar   PetscErrorCode ierr;
13622b4ed282SShri Abhyankar   SNES_VI      *vi = (SNES_VI*) snes->data;
13632b4ed282SShri Abhyankar   PetscInt       i_start[3],i_end[3];
13642b4ed282SShri Abhyankar 
13652b4ed282SShri Abhyankar   PetscFunctionBegin;
13662b4ed282SShri Abhyankar   if (!snes->vec_sol_update) {
13672b4ed282SShri Abhyankar     ierr = VecDuplicate(snes->vec_sol,&snes->vec_sol_update);CHKERRQ(ierr);
13682b4ed282SShri Abhyankar     ierr = PetscLogObjectParent(snes,snes->vec_sol_update);CHKERRQ(ierr);
13692b4ed282SShri Abhyankar   }
13702b4ed282SShri Abhyankar   if (!snes->work) {
13712b4ed282SShri Abhyankar     snes->nwork = 3;
13722b4ed282SShri Abhyankar     ierr = VecDuplicateVecs(snes->vec_sol,snes->nwork,&snes->work);CHKERRQ(ierr);
13732b4ed282SShri Abhyankar     ierr = PetscLogObjectParents(snes,snes->nwork,snes->work);CHKERRQ(ierr);
13742b4ed282SShri Abhyankar   }
13752b4ed282SShri Abhyankar 
13762b4ed282SShri Abhyankar   /* If the lower and upper bound on variables are not set, set it to
13772b4ed282SShri Abhyankar      -Inf and Inf */
13782b4ed282SShri Abhyankar   if (!vi->xl && !vi->xu) {
13792b4ed282SShri Abhyankar     vi->usersetxbounds = PETSC_FALSE;
13802b4ed282SShri Abhyankar     ierr = VecDuplicate(snes->vec_sol, &vi->xl); CHKERRQ(ierr);
13812b4ed282SShri Abhyankar     ierr = VecSet(vi->xl,PETSC_VI_NINF);CHKERRQ(ierr);
13822b4ed282SShri Abhyankar     ierr = VecDuplicate(snes->vec_sol, &vi->xu); CHKERRQ(ierr);
13832b4ed282SShri Abhyankar     ierr = VecSet(vi->xu,PETSC_VI_INF);CHKERRQ(ierr);
13842b4ed282SShri Abhyankar   } else {
13852b4ed282SShri Abhyankar     /* Check if lower bound, upper bound and solution vector distribution across the processors is identical */
13862b4ed282SShri Abhyankar     ierr = VecGetOwnershipRange(snes->vec_sol,i_start,i_end);CHKERRQ(ierr);
13872b4ed282SShri Abhyankar     ierr = VecGetOwnershipRange(vi->xl,i_start+1,i_end+1);CHKERRQ(ierr);
13882b4ed282SShri Abhyankar     ierr = VecGetOwnershipRange(vi->xu,i_start+2,i_end+2);CHKERRQ(ierr);
13892b4ed282SShri 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]))
13902b4ed282SShri 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.");
13912b4ed282SShri Abhyankar   }
13922b4ed282SShri Abhyankar 
1393fe835674SShri Abhyankar   if (snes->ops->solve != SNESSolveVI_RS) {
1394fe835674SShri Abhyankar     ierr = VecDuplicate(snes->vec_sol, &vi->dpsi);CHKERRQ(ierr);
1395fe835674SShri Abhyankar     ierr = VecDuplicate(snes->vec_sol, &vi->phi); CHKERRQ(ierr);
1396fe835674SShri Abhyankar     ierr = VecDuplicate(snes->vec_sol, &vi->Da); CHKERRQ(ierr);
1397fe835674SShri Abhyankar     ierr = VecDuplicate(snes->vec_sol, &vi->Db); CHKERRQ(ierr);
1398fe835674SShri Abhyankar     ierr = VecDuplicate(snes->vec_sol, &vi->z);CHKERRQ(ierr);
1399fe835674SShri Abhyankar     ierr = VecDuplicate(snes->vec_sol, &vi->t); CHKERRQ(ierr);
1400fe835674SShri Abhyankar 
1401fe835674SShri Abhyankar 
14022b4ed282SShri Abhyankar     vi->computeuserfunction = snes->ops->computefunction;
14031f79c099SShri Abhyankar     snes->ops->computefunction = SNESVIComputeFunction;
1404fe835674SShri Abhyankar   }
14052b4ed282SShri Abhyankar   PetscFunctionReturn(0);
14062b4ed282SShri Abhyankar }
14072b4ed282SShri Abhyankar /* -------------------------------------------------------------------------- */
14082b4ed282SShri Abhyankar /*
14092b4ed282SShri Abhyankar    SNESDestroy_VI - Destroys the private SNES_VI context that was created
14102b4ed282SShri Abhyankar    with SNESCreate_VI().
14112b4ed282SShri Abhyankar 
14122b4ed282SShri Abhyankar    Input Parameter:
14132b4ed282SShri Abhyankar .  snes - the SNES context
14142b4ed282SShri Abhyankar 
14152b4ed282SShri Abhyankar    Application Interface Routine: SNESDestroy()
14162b4ed282SShri Abhyankar  */
14172b4ed282SShri Abhyankar #undef __FUNCT__
14182b4ed282SShri Abhyankar #define __FUNCT__ "SNESDestroy_VI"
14192b4ed282SShri Abhyankar PetscErrorCode SNESDestroy_VI(SNES snes)
14202b4ed282SShri Abhyankar {
14212b4ed282SShri Abhyankar   SNES_VI        *vi = (SNES_VI*) snes->data;
14222b4ed282SShri Abhyankar   PetscErrorCode ierr;
14232b4ed282SShri Abhyankar 
14242b4ed282SShri Abhyankar   PetscFunctionBegin;
14252b4ed282SShri Abhyankar   if (snes->vec_sol_update) {
14262b4ed282SShri Abhyankar     ierr = VecDestroy(snes->vec_sol_update);CHKERRQ(ierr);
14272b4ed282SShri Abhyankar     snes->vec_sol_update = PETSC_NULL;
14282b4ed282SShri Abhyankar   }
14292b4ed282SShri Abhyankar   if (snes->nwork) {
14302b4ed282SShri Abhyankar     ierr = VecDestroyVecs(snes->work,snes->nwork);CHKERRQ(ierr);
14312b4ed282SShri Abhyankar     snes->nwork = 0;
14322b4ed282SShri Abhyankar     snes->work  = PETSC_NULL;
14332b4ed282SShri Abhyankar   }
14342b4ed282SShri Abhyankar 
1435fe835674SShri Abhyankar   if (snes->ops->solve != SNESSolveVI_RS) {
14362b4ed282SShri Abhyankar     /* clear vectors */
1437ee657d29SShri Abhyankar     ierr = VecDestroy(vi->dpsi);CHKERRQ(ierr);
14382b4ed282SShri Abhyankar     ierr = VecDestroy(vi->phi); CHKERRQ(ierr);
14392b4ed282SShri Abhyankar     ierr = VecDestroy(vi->Da); CHKERRQ(ierr);
14402b4ed282SShri Abhyankar     ierr = VecDestroy(vi->Db); CHKERRQ(ierr);
14412b4ed282SShri Abhyankar     ierr = VecDestroy(vi->z); CHKERRQ(ierr);
14422b4ed282SShri Abhyankar     ierr = VecDestroy(vi->t); CHKERRQ(ierr);
14432b4ed282SShri Abhyankar     if (!vi->usersetxbounds) {
14442b4ed282SShri Abhyankar       ierr = VecDestroy(vi->xl); CHKERRQ(ierr);
14452b4ed282SShri Abhyankar       ierr = VecDestroy(vi->xu); CHKERRQ(ierr);
14462b4ed282SShri Abhyankar     }
1447fe835674SShri Abhyankar   }
1448c92abb8aSShri Abhyankar   if (vi->lsmonitor) {
1449c92abb8aSShri Abhyankar     ierr = PetscViewerASCIIMonitorDestroy(vi->lsmonitor);CHKERRQ(ierr);
14502b4ed282SShri Abhyankar   }
14512b4ed282SShri Abhyankar   ierr = PetscFree(snes->data);CHKERRQ(ierr);
14522b4ed282SShri Abhyankar 
14532b4ed282SShri Abhyankar   /* clear composed functions */
14542b4ed282SShri Abhyankar   ierr = PetscObjectComposeFunctionDynamic((PetscObject)snes,"SNESLineSearchSet_C","",PETSC_NULL);CHKERRQ(ierr);
1455c92abb8aSShri Abhyankar   ierr = PetscObjectComposeFunctionDynamic((PetscObject)snes,"SNESLineSearchSetMonitor_C","",PETSC_NULL);CHKERRQ(ierr);
14562b4ed282SShri Abhyankar   PetscFunctionReturn(0);
14572b4ed282SShri Abhyankar }
14582b4ed282SShri Abhyankar /* -------------------------------------------------------------------------- */
14592b4ed282SShri Abhyankar #undef __FUNCT__
14602b4ed282SShri Abhyankar #define __FUNCT__ "SNESLineSearchNo_VI"
14612b4ed282SShri Abhyankar 
14622b4ed282SShri Abhyankar /*
14632b4ed282SShri Abhyankar   This routine is a copy of SNESLineSearchNo routine in snes/impls/ls/ls.c
14642b4ed282SShri Abhyankar 
14652b4ed282SShri Abhyankar */
1466ace3abfcSBarry 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)
14672b4ed282SShri Abhyankar {
14682b4ed282SShri Abhyankar   PetscErrorCode ierr;
14692b4ed282SShri Abhyankar   SNES_VI        *vi = (SNES_VI*)snes->data;
1470ace3abfcSBarry Smith   PetscBool     changed_w = PETSC_FALSE,changed_y = PETSC_FALSE;
14712b4ed282SShri Abhyankar 
14722b4ed282SShri Abhyankar   PetscFunctionBegin;
14732b4ed282SShri Abhyankar   *flag = PETSC_TRUE;
14742b4ed282SShri Abhyankar   ierr = PetscLogEventBegin(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr);
14752b4ed282SShri Abhyankar   ierr = VecNorm(y,NORM_2,ynorm);CHKERRQ(ierr);         /* ynorm = || y || */
14762b4ed282SShri Abhyankar   ierr = VecWAXPY(w,-1.0,y,x);CHKERRQ(ierr);            /* w <- x - y   */
14772b4ed282SShri Abhyankar   if (vi->postcheckstep) {
14782b4ed282SShri Abhyankar    ierr = (*vi->postcheckstep)(snes,x,y,w,vi->postcheck,&changed_y,&changed_w);CHKERRQ(ierr);
14792b4ed282SShri Abhyankar   }
14802b4ed282SShri Abhyankar   if (changed_y) {
14812b4ed282SShri Abhyankar     ierr = VecWAXPY(w,-1.0,y,x);CHKERRQ(ierr);            /* w <- x - y   */
14822b4ed282SShri Abhyankar   }
14832b4ed282SShri Abhyankar   ierr = SNESComputeFunction(snes,w,g);CHKERRQ(ierr);
14842b4ed282SShri Abhyankar   if (!snes->domainerror) {
14852b4ed282SShri Abhyankar     ierr = VecNorm(g,NORM_2,gnorm);CHKERRQ(ierr);  /* gnorm = || g || */
14862b4ed282SShri Abhyankar     if PetscIsInfOrNanReal(*gnorm) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FP,"User provided compute function generated a Not-a-Number");
14872b4ed282SShri Abhyankar   }
1488c92abb8aSShri Abhyankar   if (vi->lsmonitor) {
1489c92abb8aSShri Abhyankar     ierr = PetscViewerASCIIMonitorPrintf(vi->lsmonitor,"    Line search: Using full step: fnorm %G gnorm %G\n",fnorm,*gnorm);CHKERRQ(ierr);
1490c92abb8aSShri Abhyankar   }
14912b4ed282SShri Abhyankar   ierr = PetscLogEventEnd(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr);
14922b4ed282SShri Abhyankar   PetscFunctionReturn(0);
14932b4ed282SShri Abhyankar }
14942b4ed282SShri Abhyankar 
14952b4ed282SShri Abhyankar /* -------------------------------------------------------------------------- */
14962b4ed282SShri Abhyankar #undef __FUNCT__
1497*c1a5e521SShri Abhyankar #define __FUNCT__ "SNESLineSearchBoundProjectedNo_VI"
1498*c1a5e521SShri Abhyankar 
1499*c1a5e521SShri Abhyankar /*
1500*c1a5e521SShri Abhyankar   This routine does not actually do a line search but it takes a full newton
1501*c1a5e521SShri Abhyankar   step while ensuring that the new iterates remain within the constraints.
1502*c1a5e521SShri Abhyankar 
1503*c1a5e521SShri Abhyankar */
1504*c1a5e521SShri Abhyankar PetscErrorCode SNESLineSearchBoundProjectedNo_VI(SNES snes,void *lsctx,Vec x,Vec f,Vec g,Vec y,Vec w,PetscReal fnorm,PetscReal xnorm,PetscReal *ynorm,PetscReal *gnorm,PetscBool *flag)
1505*c1a5e521SShri Abhyankar {
1506*c1a5e521SShri Abhyankar   PetscErrorCode ierr;
1507*c1a5e521SShri Abhyankar   SNES_VI        *vi = (SNES_VI*)snes->data;
1508*c1a5e521SShri Abhyankar   PetscBool     changed_w = PETSC_FALSE,changed_y = PETSC_FALSE;
1509*c1a5e521SShri Abhyankar 
1510*c1a5e521SShri Abhyankar   PetscFunctionBegin;
1511*c1a5e521SShri Abhyankar   *flag = PETSC_TRUE;
1512*c1a5e521SShri Abhyankar   ierr = PetscLogEventBegin(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr);
1513*c1a5e521SShri Abhyankar   ierr = VecNorm(y,NORM_2,ynorm);CHKERRQ(ierr);         /* ynorm = || y || */
1514*c1a5e521SShri Abhyankar   ierr = VecWAXPY(w,-1.0,y,x);CHKERRQ(ierr);            /* w <- x - y   */
1515*c1a5e521SShri Abhyankar   ierr = SNESVIProjectOntoBounds(snes,w);CHKERRQ(ierr);
1516*c1a5e521SShri Abhyankar   if (vi->postcheckstep) {
1517*c1a5e521SShri Abhyankar    ierr = (*vi->postcheckstep)(snes,x,y,w,vi->postcheck,&changed_y,&changed_w);CHKERRQ(ierr);
1518*c1a5e521SShri Abhyankar   }
1519*c1a5e521SShri Abhyankar   if (changed_y) {
1520*c1a5e521SShri Abhyankar     ierr = VecWAXPY(w,-1.0,y,x);CHKERRQ(ierr);            /* w <- x - y   */
1521*c1a5e521SShri Abhyankar   }
1522*c1a5e521SShri Abhyankar   ierr = SNESVIProjectOntoBounds(snes,w);CHKERRQ(ierr);
1523*c1a5e521SShri Abhyankar   ierr = SNESComputeFunction(snes,w,g);CHKERRQ(ierr);
1524*c1a5e521SShri Abhyankar   if (!snes->domainerror) {
1525*c1a5e521SShri Abhyankar     ierr = VecNorm(g,NORM_2,gnorm);CHKERRQ(ierr);  /* gnorm = || g || */
1526*c1a5e521SShri Abhyankar     if PetscIsInfOrNanReal(*gnorm) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FP,"User provided compute function generated a Not-a-Number");
1527*c1a5e521SShri Abhyankar   }
1528*c1a5e521SShri Abhyankar   if (vi->lsmonitor) {
1529*c1a5e521SShri Abhyankar     ierr = PetscViewerASCIIMonitorPrintf(vi->lsmonitor,"    Line search: Using full step: fnorm %G gnorm %G\n",fnorm,*gnorm);CHKERRQ(ierr);
1530*c1a5e521SShri Abhyankar   }
1531*c1a5e521SShri Abhyankar   ierr = PetscLogEventEnd(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr);
1532*c1a5e521SShri Abhyankar   PetscFunctionReturn(0);
1533*c1a5e521SShri Abhyankar }
1534*c1a5e521SShri Abhyankar 
1535*c1a5e521SShri Abhyankar /* -------------------------------------------------------------------------- */
1536*c1a5e521SShri Abhyankar #undef __FUNCT__
15372b4ed282SShri Abhyankar #define __FUNCT__ "SNESLineSearchNoNorms_VI"
15382b4ed282SShri Abhyankar 
15392b4ed282SShri Abhyankar /*
15402b4ed282SShri Abhyankar   This routine is a copy of SNESLineSearchNoNorms in snes/impls/ls/ls.c
15412b4ed282SShri Abhyankar */
1542ace3abfcSBarry 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)
15432b4ed282SShri Abhyankar {
15442b4ed282SShri Abhyankar   PetscErrorCode ierr;
15452b4ed282SShri Abhyankar   SNES_VI        *vi = (SNES_VI*)snes->data;
1546ace3abfcSBarry Smith   PetscBool     changed_w = PETSC_FALSE,changed_y = PETSC_FALSE;
15472b4ed282SShri Abhyankar 
15482b4ed282SShri Abhyankar   PetscFunctionBegin;
15492b4ed282SShri Abhyankar   *flag = PETSC_TRUE;
15502b4ed282SShri Abhyankar   ierr = PetscLogEventBegin(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr);
15512b4ed282SShri Abhyankar   ierr = VecWAXPY(w,-1.0,y,x);CHKERRQ(ierr);            /* w <- x - y      */
15522b4ed282SShri Abhyankar   if (vi->postcheckstep) {
15532b4ed282SShri Abhyankar    ierr = (*vi->postcheckstep)(snes,x,y,w,vi->postcheck,&changed_y,&changed_w);CHKERRQ(ierr);
15542b4ed282SShri Abhyankar   }
15552b4ed282SShri Abhyankar   if (changed_y) {
15562b4ed282SShri Abhyankar     ierr = VecWAXPY(w,-1.0,y,x);CHKERRQ(ierr);            /* w <- x - y   */
15572b4ed282SShri Abhyankar   }
15582b4ed282SShri Abhyankar 
15592b4ed282SShri Abhyankar   /* don't evaluate function the last time through */
15602b4ed282SShri Abhyankar   if (snes->iter < snes->max_its-1) {
15612b4ed282SShri Abhyankar     ierr = SNESComputeFunction(snes,w,g);CHKERRQ(ierr);
15622b4ed282SShri Abhyankar   }
15632b4ed282SShri Abhyankar   ierr = PetscLogEventEnd(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr);
15642b4ed282SShri Abhyankar   PetscFunctionReturn(0);
15652b4ed282SShri Abhyankar }
15662b4ed282SShri Abhyankar /* -------------------------------------------------------------------------- */
15672b4ed282SShri Abhyankar #undef __FUNCT__
15682b4ed282SShri Abhyankar #define __FUNCT__ "SNESLineSearchCubic_VI"
15692b4ed282SShri Abhyankar /*
15702b4ed282SShri Abhyankar   This routine is a copy of SNESLineSearchCubic in snes/impls/ls/ls.c
15712b4ed282SShri Abhyankar */
1572ace3abfcSBarry 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)
15732b4ed282SShri Abhyankar {
15742b4ed282SShri Abhyankar   /*
15752b4ed282SShri Abhyankar      Note that for line search purposes we work with with the related
15762b4ed282SShri Abhyankar      minimization problem:
15772b4ed282SShri Abhyankar         min  z(x):  R^n -> R,
15782b4ed282SShri Abhyankar      where z(x) = .5 * fnorm*fnorm, and fnorm = || f ||_2.
15792b4ed282SShri Abhyankar      This function z(x) is same as the merit function for the complementarity problem.
15802b4ed282SShri Abhyankar    */
15812b4ed282SShri Abhyankar 
15822b4ed282SShri Abhyankar   PetscReal      initslope,lambdaprev,gnormprev,a,b,d,t1,t2,rellength;
15832b4ed282SShri Abhyankar   PetscReal      minlambda,lambda,lambdatemp;
15842b4ed282SShri Abhyankar #if defined(PETSC_USE_COMPLEX)
15852b4ed282SShri Abhyankar   PetscScalar    cinitslope;
15862b4ed282SShri Abhyankar #endif
15872b4ed282SShri Abhyankar   PetscErrorCode ierr;
15882b4ed282SShri Abhyankar   PetscInt       count;
15892b4ed282SShri Abhyankar   SNES_VI      *vi = (SNES_VI*)snes->data;
1590ace3abfcSBarry Smith   PetscBool     changed_w = PETSC_FALSE,changed_y = PETSC_FALSE;
15912b4ed282SShri Abhyankar   MPI_Comm       comm;
15922b4ed282SShri Abhyankar 
15932b4ed282SShri Abhyankar   PetscFunctionBegin;
15942b4ed282SShri Abhyankar   ierr = PetscObjectGetComm((PetscObject)snes,&comm);CHKERRQ(ierr);
15952b4ed282SShri Abhyankar   ierr = PetscLogEventBegin(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr);
15962b4ed282SShri Abhyankar   *flag   = PETSC_TRUE;
15972b4ed282SShri Abhyankar 
15982b4ed282SShri Abhyankar   ierr = VecNorm(y,NORM_2,ynorm);CHKERRQ(ierr);
15992b4ed282SShri Abhyankar   if (*ynorm == 0.0) {
1600c92abb8aSShri Abhyankar     if (vi->lsmonitor) {
1601c92abb8aSShri Abhyankar       ierr = PetscViewerASCIIMonitorPrintf(vi->lsmonitor,"    Line search: Initial direction and size is 0\n");CHKERRQ(ierr);
16022b4ed282SShri Abhyankar     }
16032b4ed282SShri Abhyankar     *gnorm = fnorm;
16042b4ed282SShri Abhyankar     ierr   = VecCopy(x,w);CHKERRQ(ierr);
16052b4ed282SShri Abhyankar     ierr   = VecCopy(f,g);CHKERRQ(ierr);
16062b4ed282SShri Abhyankar     *flag  = PETSC_FALSE;
16072b4ed282SShri Abhyankar     goto theend1;
16082b4ed282SShri Abhyankar   }
16092b4ed282SShri Abhyankar   if (*ynorm > vi->maxstep) {	/* Step too big, so scale back */
1610c92abb8aSShri Abhyankar     if (vi->lsmonitor) {
1611c92abb8aSShri Abhyankar       ierr = PetscViewerASCIIMonitorPrintf(vi->lsmonitor,"    Line search: Scaling step by %G old ynorm %G\n",vi->maxstep/(*ynorm),*ynorm);CHKERRQ(ierr);
16122b4ed282SShri Abhyankar     }
16132b4ed282SShri Abhyankar     ierr = VecScale(y,vi->maxstep/(*ynorm));CHKERRQ(ierr);
16142b4ed282SShri Abhyankar     *ynorm = vi->maxstep;
16152b4ed282SShri Abhyankar   }
16162b4ed282SShri Abhyankar   ierr      = VecMaxPointwiseDivide(y,x,&rellength);CHKERRQ(ierr);
16172b4ed282SShri Abhyankar   minlambda = vi->minlambda/rellength;
16182b4ed282SShri Abhyankar #if defined(PETSC_USE_COMPLEX)
161989d9e806SShri Abhyankar   ierr = VecDot(vi->dpsi,y,&cinitslope);CHKERRQ(ierr);
16202b4ed282SShri Abhyankar   initslope = PetscRealPart(cinitslope);
16212b4ed282SShri Abhyankar #else
162289d9e806SShri Abhyankar   ierr = VecDot(vi->dpsi,y,&initslope);CHKERRQ(ierr);
16232b4ed282SShri Abhyankar #endif
16242b4ed282SShri Abhyankar   if (initslope > 0.0)  initslope = -initslope;
16252b4ed282SShri Abhyankar   if (initslope == 0.0) initslope = -1.0;
16262b4ed282SShri Abhyankar 
16272b4ed282SShri Abhyankar   ierr = VecWAXPY(w,-1.0,y,x);CHKERRQ(ierr);
16282b4ed282SShri Abhyankar   if (snes->nfuncs >= snes->max_funcs) {
16292b4ed282SShri Abhyankar     ierr  = PetscInfo(snes,"Exceeded maximum function evaluations, while checking full step length!\n");CHKERRQ(ierr);
16302b4ed282SShri Abhyankar     *flag = PETSC_FALSE;
16312b4ed282SShri Abhyankar     snes->reason = SNES_DIVERGED_FUNCTION_COUNT;
16322b4ed282SShri Abhyankar     goto theend1;
16332b4ed282SShri Abhyankar   }
16342b4ed282SShri Abhyankar   ierr = SNESComputeFunction(snes,w,g);CHKERRQ(ierr);
16352b4ed282SShri Abhyankar   if (snes->domainerror) {
16362b4ed282SShri Abhyankar     ierr = PetscLogEventEnd(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr);
16372b4ed282SShri Abhyankar     PetscFunctionReturn(0);
16382b4ed282SShri Abhyankar   }
16392b4ed282SShri Abhyankar   ierr = VecNorm(g,NORM_2,gnorm);CHKERRQ(ierr);
16402b4ed282SShri Abhyankar   if PetscIsInfOrNanReal(*gnorm) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FP,"User provided compute function generated a Not-a-Number");
16412b4ed282SShri Abhyankar   ierr = PetscInfo2(snes,"Initial fnorm %G gnorm %G\n",fnorm,*gnorm);CHKERRQ(ierr);
16422b4ed282SShri Abhyankar   if (.5*(*gnorm)*(*gnorm) <= .5*fnorm*fnorm + vi->alpha*initslope) { /* Sufficient reduction */
1643c92abb8aSShri Abhyankar     if (vi->lsmonitor) {
1644c92abb8aSShri Abhyankar       ierr = PetscViewerASCIIMonitorPrintf(vi->lsmonitor,"    Line search: Using full step: fnorm %G gnorm %G\n",fnorm,*gnorm);CHKERRQ(ierr);
16452b4ed282SShri Abhyankar     }
16462b4ed282SShri Abhyankar     goto theend1;
16472b4ed282SShri Abhyankar   }
16482b4ed282SShri Abhyankar 
16492b4ed282SShri Abhyankar   /* Fit points with quadratic */
16502b4ed282SShri Abhyankar   lambda     = 1.0;
16512b4ed282SShri Abhyankar   lambdatemp = -initslope/((*gnorm)*(*gnorm) - fnorm*fnorm - 2.0*initslope);
16522b4ed282SShri Abhyankar   lambdaprev = lambda;
16532b4ed282SShri Abhyankar   gnormprev  = *gnorm;
16542b4ed282SShri Abhyankar   if (lambdatemp > .5*lambda)  lambdatemp = .5*lambda;
16552b4ed282SShri Abhyankar   if (lambdatemp <= .1*lambda) lambda = .1*lambda;
16562b4ed282SShri Abhyankar   else                         lambda = lambdatemp;
16572b4ed282SShri Abhyankar 
16582b4ed282SShri Abhyankar   ierr  = VecWAXPY(w,-lambda,y,x);CHKERRQ(ierr);
16592b4ed282SShri Abhyankar   if (snes->nfuncs >= snes->max_funcs) {
16602b4ed282SShri Abhyankar     ierr  = PetscInfo1(snes,"Exceeded maximum function evaluations, while attempting quadratic backtracking! %D \n",snes->nfuncs);CHKERRQ(ierr);
16612b4ed282SShri Abhyankar     *flag = PETSC_FALSE;
16622b4ed282SShri Abhyankar     snes->reason = SNES_DIVERGED_FUNCTION_COUNT;
16632b4ed282SShri Abhyankar     goto theend1;
16642b4ed282SShri Abhyankar   }
16652b4ed282SShri Abhyankar   ierr = SNESComputeFunction(snes,w,g);CHKERRQ(ierr);
16662b4ed282SShri Abhyankar   if (snes->domainerror) {
16672b4ed282SShri Abhyankar     ierr = PetscLogEventEnd(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr);
16682b4ed282SShri Abhyankar     PetscFunctionReturn(0);
16692b4ed282SShri Abhyankar   }
16702b4ed282SShri Abhyankar   ierr = VecNorm(g,NORM_2,gnorm);CHKERRQ(ierr);
16712b4ed282SShri Abhyankar   if PetscIsInfOrNanReal(*gnorm) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FP,"User provided compute function generated a Not-a-Number");
1672c92abb8aSShri Abhyankar   if (vi->lsmonitor) {
1673c92abb8aSShri Abhyankar     ierr = PetscViewerASCIIMonitorPrintf(vi->lsmonitor,"    Line search: gnorm after quadratic fit %G\n",*gnorm);CHKERRQ(ierr);
16742b4ed282SShri Abhyankar   }
16752b4ed282SShri Abhyankar   if (.5*(*gnorm)*(*gnorm) < .5*fnorm*fnorm + lambda*vi->alpha*initslope) { /* sufficient reduction */
1676c92abb8aSShri Abhyankar     if (vi->lsmonitor) {
1677c92abb8aSShri Abhyankar       ierr = PetscViewerASCIIMonitorPrintf(vi->lsmonitor,"    Line search: Quadratically determined step, lambda=%18.16e\n",lambda);CHKERRQ(ierr);
16782b4ed282SShri Abhyankar     }
16792b4ed282SShri Abhyankar     goto theend1;
16802b4ed282SShri Abhyankar   }
16812b4ed282SShri Abhyankar 
16822b4ed282SShri Abhyankar   /* Fit points with cubic */
16832b4ed282SShri Abhyankar   count = 1;
16842b4ed282SShri Abhyankar   while (PETSC_TRUE) {
16852b4ed282SShri Abhyankar     if (lambda <= minlambda) {
1686c92abb8aSShri Abhyankar       if (vi->lsmonitor) {
1687c92abb8aSShri Abhyankar 	ierr = PetscViewerASCIIMonitorPrintf(vi->lsmonitor,"    Line search: unable to find good step length! After %D tries \n",count);CHKERRQ(ierr);
1688c92abb8aSShri 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);
16892b4ed282SShri Abhyankar       }
16902b4ed282SShri Abhyankar       *flag = PETSC_FALSE;
16912b4ed282SShri Abhyankar       break;
16922b4ed282SShri Abhyankar     }
16932b4ed282SShri Abhyankar     t1 = .5*((*gnorm)*(*gnorm) - fnorm*fnorm) - lambda*initslope;
16942b4ed282SShri Abhyankar     t2 = .5*(gnormprev*gnormprev  - fnorm*fnorm) - lambdaprev*initslope;
16952b4ed282SShri Abhyankar     a  = (t1/(lambda*lambda) - t2/(lambdaprev*lambdaprev))/(lambda-lambdaprev);
16962b4ed282SShri Abhyankar     b  = (-lambdaprev*t1/(lambda*lambda) + lambda*t2/(lambdaprev*lambdaprev))/(lambda-lambdaprev);
16972b4ed282SShri Abhyankar     d  = b*b - 3*a*initslope;
16982b4ed282SShri Abhyankar     if (d < 0.0) d = 0.0;
16992b4ed282SShri Abhyankar     if (a == 0.0) {
17002b4ed282SShri Abhyankar       lambdatemp = -initslope/(2.0*b);
17012b4ed282SShri Abhyankar     } else {
17022b4ed282SShri Abhyankar       lambdatemp = (-b + sqrt(d))/(3.0*a);
17032b4ed282SShri Abhyankar     }
17042b4ed282SShri Abhyankar     lambdaprev = lambda;
17052b4ed282SShri Abhyankar     gnormprev  = *gnorm;
17062b4ed282SShri Abhyankar     if (lambdatemp > .5*lambda)  lambdatemp = .5*lambda;
17072b4ed282SShri Abhyankar     if (lambdatemp <= .1*lambda) lambda     = .1*lambda;
17082b4ed282SShri Abhyankar     else                         lambda     = lambdatemp;
17092b4ed282SShri Abhyankar     ierr  = VecWAXPY(w,-lambda,y,x);CHKERRQ(ierr);
17102b4ed282SShri Abhyankar     if (snes->nfuncs >= snes->max_funcs) {
17112b4ed282SShri Abhyankar       ierr = PetscInfo1(snes,"Exceeded maximum function evaluations, while looking for good step length! %D \n",count);CHKERRQ(ierr);
17122b4ed282SShri 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);
17132b4ed282SShri Abhyankar       *flag = PETSC_FALSE;
17142b4ed282SShri Abhyankar       snes->reason = SNES_DIVERGED_FUNCTION_COUNT;
17152b4ed282SShri Abhyankar       break;
17162b4ed282SShri Abhyankar     }
17172b4ed282SShri Abhyankar     ierr = SNESComputeFunction(snes,w,g);CHKERRQ(ierr);
17182b4ed282SShri Abhyankar     if (snes->domainerror) {
17192b4ed282SShri Abhyankar       ierr = PetscLogEventEnd(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr);
17202b4ed282SShri Abhyankar       PetscFunctionReturn(0);
17212b4ed282SShri Abhyankar     }
17222b4ed282SShri Abhyankar     ierr = VecNorm(g,NORM_2,gnorm);CHKERRQ(ierr);
17232b4ed282SShri Abhyankar     if PetscIsInfOrNanReal(*gnorm) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FP,"User provided compute function generated a Not-a-Number");
17242b4ed282SShri Abhyankar     if (.5*(*gnorm)*(*gnorm) < .5*fnorm*fnorm + lambda*vi->alpha*initslope) { /* is reduction enough? */
1725c92abb8aSShri Abhyankar       if (vi->lsmonitor) {
17262b4ed282SShri Abhyankar 	ierr = PetscPrintf(comm,"    Line search: Cubically determined step, current gnorm %G lambda=%18.16e\n",*gnorm,lambda);CHKERRQ(ierr);
17272b4ed282SShri Abhyankar       }
17282b4ed282SShri Abhyankar       break;
17292b4ed282SShri Abhyankar     } else {
1730c92abb8aSShri Abhyankar       if (vi->lsmonitor) {
17312b4ed282SShri Abhyankar         ierr = PetscPrintf(comm,"    Line search: Cubic step no good, shrinking lambda, current gnorm %G lambda=%18.16e\n",*gnorm,lambda);CHKERRQ(ierr);
17322b4ed282SShri Abhyankar       }
17332b4ed282SShri Abhyankar     }
17342b4ed282SShri Abhyankar     count++;
17352b4ed282SShri Abhyankar   }
17362b4ed282SShri Abhyankar   theend1:
17372b4ed282SShri Abhyankar   /* Optional user-defined check for line search step validity */
17382b4ed282SShri Abhyankar   if (vi->postcheckstep && *flag) {
17392b4ed282SShri Abhyankar     ierr = (*vi->postcheckstep)(snes,x,y,w,vi->postcheck,&changed_y,&changed_w);CHKERRQ(ierr);
17402b4ed282SShri Abhyankar     if (changed_y) {
17412b4ed282SShri Abhyankar       ierr = VecWAXPY(w,-1.0,y,x);CHKERRQ(ierr);
17422b4ed282SShri Abhyankar     }
17432b4ed282SShri Abhyankar     if (changed_y || changed_w) { /* recompute the function if the step has changed */
17442b4ed282SShri Abhyankar       ierr = SNESComputeFunction(snes,w,g);CHKERRQ(ierr);
17452b4ed282SShri Abhyankar       if (snes->domainerror) {
17462b4ed282SShri Abhyankar         ierr = PetscLogEventEnd(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr);
17472b4ed282SShri Abhyankar         PetscFunctionReturn(0);
17482b4ed282SShri Abhyankar       }
17492b4ed282SShri Abhyankar       ierr = VecNormBegin(g,NORM_2,gnorm);CHKERRQ(ierr);
17502b4ed282SShri Abhyankar       if PetscIsInfOrNanReal(*gnorm) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FP,"User provided compute function generated a Not-a-Number");
17512b4ed282SShri Abhyankar       ierr = VecNormBegin(y,NORM_2,ynorm);CHKERRQ(ierr);
17522b4ed282SShri Abhyankar       ierr = VecNormEnd(g,NORM_2,gnorm);CHKERRQ(ierr);
17532b4ed282SShri Abhyankar       ierr = VecNormEnd(y,NORM_2,ynorm);CHKERRQ(ierr);
17542b4ed282SShri Abhyankar     }
17552b4ed282SShri Abhyankar   }
17562b4ed282SShri Abhyankar   ierr = PetscLogEventEnd(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr);
17572b4ed282SShri Abhyankar   PetscFunctionReturn(0);
17582b4ed282SShri Abhyankar }
1759fe835674SShri Abhyankar 
1760fe835674SShri Abhyankar /* -------------------------------------------------------------------------- */
1761fe835674SShri Abhyankar #undef __FUNCT__
1762fe835674SShri Abhyankar #define __FUNCT__ "SNESLineSearchBoundProjectedCubic_VI"
1763fe835674SShri Abhyankar /*
1764*c1a5e521SShri Abhyankar   This routine implements a cubic line search while keeping the iterates within bounds
1765fe835674SShri Abhyankar */
1766fe835674SShri Abhyankar PetscErrorCode SNESLineSearchBoundProjectedCubic_VI(SNES snes,void *lsctx,Vec x,Vec f,Vec g,Vec y,Vec w,PetscReal fnorm,PetscReal xnorm,PetscReal *ynorm,PetscReal *gnorm,PetscBool *flag)
1767fe835674SShri Abhyankar {
1768fe835674SShri Abhyankar   PetscReal      initslope,lambdaprev,gnormprev,a,b,d,t1,t2,rellength;
1769fe835674SShri Abhyankar   PetscReal      minlambda,lambda,lambdatemp;
1770fe835674SShri Abhyankar #if defined(PETSC_USE_COMPLEX)
1771fe835674SShri Abhyankar   PetscScalar    cinitslope;
1772fe835674SShri Abhyankar #endif
1773fe835674SShri Abhyankar   PetscErrorCode ierr;
1774fe835674SShri Abhyankar   PetscInt       count;
1775fe835674SShri Abhyankar   SNES_VI        *vi = (SNES_VI*)snes->data;
1776fe835674SShri Abhyankar   PetscBool      changed_w = PETSC_FALSE,changed_y = PETSC_FALSE;
1777fe835674SShri Abhyankar   MPI_Comm       comm;
1778fe835674SShri Abhyankar 
1779fe835674SShri Abhyankar   PetscFunctionBegin;
1780fe835674SShri Abhyankar   ierr = PetscObjectGetComm((PetscObject)snes,&comm);CHKERRQ(ierr);
1781fe835674SShri Abhyankar   ierr = PetscLogEventBegin(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr);
1782fe835674SShri Abhyankar   *flag   = PETSC_TRUE;
1783fe835674SShri Abhyankar 
1784fe835674SShri Abhyankar   ierr = VecNorm(y,NORM_2,ynorm);CHKERRQ(ierr);
1785fe835674SShri Abhyankar   if (*ynorm == 0.0) {
1786fe835674SShri Abhyankar     if (vi->lsmonitor) {
1787fe835674SShri Abhyankar       ierr = PetscViewerASCIIMonitorPrintf(vi->lsmonitor,"    Line search: Initial direction and size is 0\n");CHKERRQ(ierr);
1788fe835674SShri Abhyankar     }
1789fe835674SShri Abhyankar     *gnorm = fnorm;
1790fe835674SShri Abhyankar     ierr   = VecCopy(x,w);CHKERRQ(ierr);
1791fe835674SShri Abhyankar     ierr   = VecCopy(f,g);CHKERRQ(ierr);
1792fe835674SShri Abhyankar     *flag  = PETSC_FALSE;
1793fe835674SShri Abhyankar     goto theend1;
1794fe835674SShri Abhyankar   }
1795fe835674SShri Abhyankar   if (*ynorm > vi->maxstep) {	/* Step too big, so scale back */
1796fe835674SShri Abhyankar     if (vi->lsmonitor) {
1797fe835674SShri Abhyankar       ierr = PetscViewerASCIIMonitorPrintf(vi->lsmonitor,"    Line search: Scaling step by %G old ynorm %G\n",vi->maxstep/(*ynorm),*ynorm);CHKERRQ(ierr);
1798fe835674SShri Abhyankar     }
1799fe835674SShri Abhyankar     ierr = VecScale(y,vi->maxstep/(*ynorm));CHKERRQ(ierr);
1800fe835674SShri Abhyankar     *ynorm = vi->maxstep;
1801fe835674SShri Abhyankar   }
1802fe835674SShri Abhyankar   ierr      = VecMaxPointwiseDivide(y,x,&rellength);CHKERRQ(ierr);
1803fe835674SShri Abhyankar   minlambda = vi->minlambda/rellength;
1804fe835674SShri Abhyankar   ierr = MatMult(snes->jacobian,y,w);CHKERRQ(ierr);
1805fe835674SShri Abhyankar #if defined(PETSC_USE_COMPLEX)
1806fe835674SShri Abhyankar   ierr = VecDot(f,w,&cinitslope);CHKERRQ(ierr);
1807fe835674SShri Abhyankar   initslope = PetscRealPart(cinitslope);
1808fe835674SShri Abhyankar #else
1809fe835674SShri Abhyankar   ierr = VecDot(f,w,&initslope);CHKERRQ(ierr);
1810fe835674SShri Abhyankar #endif
1811fe835674SShri Abhyankar   if (initslope > 0.0)  initslope = -initslope;
1812fe835674SShri Abhyankar   if (initslope == 0.0) initslope = -1.0;
1813fe835674SShri Abhyankar 
1814fe835674SShri Abhyankar   ierr = VecWAXPY(w,-1.0,y,x);CHKERRQ(ierr);
1815fe835674SShri Abhyankar   ierr = SNESVIProjectOntoBounds(snes,w);CHKERRQ(ierr);
1816fe835674SShri Abhyankar   if (snes->nfuncs >= snes->max_funcs) {
1817fe835674SShri Abhyankar     ierr  = PetscInfo(snes,"Exceeded maximum function evaluations, while checking full step length!\n");CHKERRQ(ierr);
1818fe835674SShri Abhyankar     *flag = PETSC_FALSE;
1819fe835674SShri Abhyankar     snes->reason = SNES_DIVERGED_FUNCTION_COUNT;
1820fe835674SShri Abhyankar     goto theend1;
1821fe835674SShri Abhyankar   }
1822fe835674SShri Abhyankar   ierr = SNESComputeFunction(snes,w,g);CHKERRQ(ierr);
1823fe835674SShri Abhyankar   ierr = SNESVIComputeInactiveSetFnorm(snes,g,w,gnorm);CHKERRQ(ierr);
1824fe835674SShri Abhyankar   if (snes->domainerror) {
1825fe835674SShri Abhyankar     ierr = PetscLogEventEnd(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr);
1826fe835674SShri Abhyankar     PetscFunctionReturn(0);
1827fe835674SShri Abhyankar   }
1828fe835674SShri Abhyankar   if PetscIsInfOrNanReal(*gnorm) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FP,"User provided compute function generated a Not-a-Number");
1829fe835674SShri Abhyankar   ierr = PetscInfo2(snes,"Initial fnorm %G gnorm %G\n",fnorm,*gnorm);CHKERRQ(ierr);
1830fe835674SShri Abhyankar   if (.5*(*gnorm)*(*gnorm) <= .5*fnorm*fnorm + vi->alpha*initslope) { /* Sufficient reduction */
1831fe835674SShri Abhyankar     if (vi->lsmonitor) {
1832fe835674SShri Abhyankar       ierr = PetscViewerASCIIMonitorPrintf(vi->lsmonitor,"    Line search: Using full step: fnorm %G gnorm %G\n",fnorm,*gnorm);CHKERRQ(ierr);
1833fe835674SShri Abhyankar     }
1834fe835674SShri Abhyankar     goto theend1;
1835fe835674SShri Abhyankar   }
1836fe835674SShri Abhyankar 
1837fe835674SShri Abhyankar   /* Fit points with quadratic */
1838fe835674SShri Abhyankar   lambda     = 1.0;
1839fe835674SShri Abhyankar   lambdatemp = -initslope/((*gnorm)*(*gnorm) - fnorm*fnorm - 2.0*initslope);
1840fe835674SShri Abhyankar   lambdaprev = lambda;
1841fe835674SShri Abhyankar   gnormprev  = *gnorm;
1842fe835674SShri Abhyankar   if (lambdatemp > .5*lambda)  lambdatemp = .5*lambda;
1843fe835674SShri Abhyankar   if (lambdatemp <= .1*lambda) lambda = .1*lambda;
1844fe835674SShri Abhyankar   else                         lambda = lambdatemp;
1845fe835674SShri Abhyankar 
1846fe835674SShri Abhyankar   ierr  = VecWAXPY(w,-lambda,y,x);CHKERRQ(ierr);
1847fe835674SShri Abhyankar   ierr = SNESVIProjectOntoBounds(snes,w);CHKERRQ(ierr);
1848fe835674SShri Abhyankar   if (snes->nfuncs >= snes->max_funcs) {
1849fe835674SShri Abhyankar     ierr  = PetscInfo1(snes,"Exceeded maximum function evaluations, while attempting quadratic backtracking! %D \n",snes->nfuncs);CHKERRQ(ierr);
1850fe835674SShri Abhyankar     *flag = PETSC_FALSE;
1851fe835674SShri Abhyankar     snes->reason = SNES_DIVERGED_FUNCTION_COUNT;
1852fe835674SShri Abhyankar     goto theend1;
1853fe835674SShri Abhyankar   }
1854fe835674SShri Abhyankar   ierr = SNESComputeFunction(snes,w,g);CHKERRQ(ierr);
1855fe835674SShri Abhyankar   ierr = SNESVIComputeInactiveSetFnorm(snes,g,w,gnorm);CHKERRQ(ierr);
1856fe835674SShri Abhyankar   if (snes->domainerror) {
1857fe835674SShri Abhyankar     ierr = PetscLogEventEnd(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr);
1858fe835674SShri Abhyankar     PetscFunctionReturn(0);
1859fe835674SShri Abhyankar   }
1860fe835674SShri Abhyankar   if PetscIsInfOrNanReal(*gnorm) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FP,"User provided compute function generated a Not-a-Number");
1861fe835674SShri Abhyankar   if (vi->lsmonitor) {
1862fe835674SShri Abhyankar     ierr = PetscViewerASCIIMonitorPrintf(vi->lsmonitor,"    Line search: gnorm after quadratic fit %G\n",*gnorm);CHKERRQ(ierr);
1863fe835674SShri Abhyankar   }
1864fe835674SShri Abhyankar   if (.5*(*gnorm)*(*gnorm) < .5*fnorm*fnorm + lambda*vi->alpha*initslope) { /* sufficient reduction */
1865fe835674SShri Abhyankar     if (vi->lsmonitor) {
1866fe835674SShri Abhyankar       ierr = PetscViewerASCIIMonitorPrintf(vi->lsmonitor,"    Line search: Quadratically determined step, lambda=%18.16e\n",lambda);CHKERRQ(ierr);
1867fe835674SShri Abhyankar     }
1868fe835674SShri Abhyankar     goto theend1;
1869fe835674SShri Abhyankar   }
1870fe835674SShri Abhyankar 
1871fe835674SShri Abhyankar   /* Fit points with cubic */
1872fe835674SShri Abhyankar   count = 1;
1873fe835674SShri Abhyankar   while (PETSC_TRUE) {
1874fe835674SShri Abhyankar     if (lambda <= minlambda) {
1875fe835674SShri Abhyankar       if (vi->lsmonitor) {
1876fe835674SShri Abhyankar 	ierr = PetscViewerASCIIMonitorPrintf(vi->lsmonitor,"    Line search: unable to find good step length! After %D tries \n",count);CHKERRQ(ierr);
1877fe835674SShri 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);
1878fe835674SShri Abhyankar       }
1879fe835674SShri Abhyankar       *flag = PETSC_FALSE;
1880fe835674SShri Abhyankar       break;
1881fe835674SShri Abhyankar     }
1882fe835674SShri Abhyankar     t1 = .5*((*gnorm)*(*gnorm) - fnorm*fnorm) - lambda*initslope;
1883fe835674SShri Abhyankar     t2 = .5*(gnormprev*gnormprev  - fnorm*fnorm) - lambdaprev*initslope;
1884fe835674SShri Abhyankar     a  = (t1/(lambda*lambda) - t2/(lambdaprev*lambdaprev))/(lambda-lambdaprev);
1885fe835674SShri Abhyankar     b  = (-lambdaprev*t1/(lambda*lambda) + lambda*t2/(lambdaprev*lambdaprev))/(lambda-lambdaprev);
1886fe835674SShri Abhyankar     d  = b*b - 3*a*initslope;
1887fe835674SShri Abhyankar     if (d < 0.0) d = 0.0;
1888fe835674SShri Abhyankar     if (a == 0.0) {
1889fe835674SShri Abhyankar       lambdatemp = -initslope/(2.0*b);
1890fe835674SShri Abhyankar     } else {
1891fe835674SShri Abhyankar       lambdatemp = (-b + sqrt(d))/(3.0*a);
1892fe835674SShri Abhyankar     }
1893fe835674SShri Abhyankar     lambdaprev = lambda;
1894fe835674SShri Abhyankar     gnormprev  = *gnorm;
1895fe835674SShri Abhyankar     if (lambdatemp > .5*lambda)  lambdatemp = .5*lambda;
1896fe835674SShri Abhyankar     if (lambdatemp <= .1*lambda) lambda     = .1*lambda;
1897fe835674SShri Abhyankar     else                         lambda     = lambdatemp;
1898fe835674SShri Abhyankar     ierr = VecWAXPY(w,-lambda,y,x);CHKERRQ(ierr);
1899fe835674SShri Abhyankar     ierr = SNESVIProjectOntoBounds(snes,w);CHKERRQ(ierr);
1900fe835674SShri Abhyankar     if (snes->nfuncs >= snes->max_funcs) {
1901fe835674SShri Abhyankar       ierr = PetscInfo1(snes,"Exceeded maximum function evaluations, while looking for good step length! %D \n",count);CHKERRQ(ierr);
1902fe835674SShri 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);
1903fe835674SShri Abhyankar       *flag = PETSC_FALSE;
1904fe835674SShri Abhyankar       snes->reason = SNES_DIVERGED_FUNCTION_COUNT;
1905fe835674SShri Abhyankar       break;
1906fe835674SShri Abhyankar     }
1907fe835674SShri Abhyankar     ierr = SNESComputeFunction(snes,w,g);CHKERRQ(ierr);
1908fe835674SShri Abhyankar     ierr = SNESVIComputeInactiveSetFnorm(snes,g,w,gnorm);CHKERRQ(ierr);
1909fe835674SShri Abhyankar     if (snes->domainerror) {
1910fe835674SShri Abhyankar       ierr = PetscLogEventEnd(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr);
1911fe835674SShri Abhyankar       PetscFunctionReturn(0);
1912fe835674SShri Abhyankar     }
1913fe835674SShri Abhyankar     if PetscIsInfOrNanReal(*gnorm) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FP,"User provided compute function generated a Not-a-Number");
1914fe835674SShri Abhyankar     if (.5*(*gnorm)*(*gnorm) < .5*fnorm*fnorm + lambda*vi->alpha*initslope) { /* is reduction enough? */
1915fe835674SShri Abhyankar       if (vi->lsmonitor) {
1916fe835674SShri Abhyankar 	ierr = PetscPrintf(comm,"    Line search: Cubically determined step, current gnorm %G lambda=%18.16e\n",*gnorm,lambda);CHKERRQ(ierr);
1917fe835674SShri Abhyankar       }
1918fe835674SShri Abhyankar       break;
1919fe835674SShri Abhyankar     } else {
1920fe835674SShri Abhyankar       if (vi->lsmonitor) {
1921fe835674SShri Abhyankar         ierr = PetscPrintf(comm,"    Line search: Cubic step no good, shrinking lambda, current gnorm %G lambda=%18.16e\n",*gnorm,lambda);CHKERRQ(ierr);
1922fe835674SShri Abhyankar       }
1923fe835674SShri Abhyankar     }
1924fe835674SShri Abhyankar     count++;
1925fe835674SShri Abhyankar   }
1926fe835674SShri Abhyankar   theend1:
1927fe835674SShri Abhyankar   /* Optional user-defined check for line search step validity */
1928fe835674SShri Abhyankar   if (vi->postcheckstep && *flag) {
1929fe835674SShri Abhyankar     ierr = (*vi->postcheckstep)(snes,x,y,w,vi->postcheck,&changed_y,&changed_w);CHKERRQ(ierr);
1930fe835674SShri Abhyankar     if (changed_y) {
1931fe835674SShri Abhyankar       ierr = VecWAXPY(w,-1.0,y,x);CHKERRQ(ierr);
1932fe835674SShri Abhyankar       ierr = SNESVIProjectOntoBounds(snes,w);CHKERRQ(ierr);
1933fe835674SShri Abhyankar     }
1934fe835674SShri Abhyankar     if (changed_y || changed_w) { /* recompute the function if the step has changed */
1935fe835674SShri Abhyankar       ierr = SNESComputeFunction(snes,w,g);CHKERRQ(ierr);
1936fe835674SShri Abhyankar       ierr = SNESVIComputeInactiveSetFnorm(snes,g,w,gnorm);CHKERRQ(ierr);
1937fe835674SShri Abhyankar       if (snes->domainerror) {
1938fe835674SShri Abhyankar         ierr = PetscLogEventEnd(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr);
1939fe835674SShri Abhyankar         PetscFunctionReturn(0);
1940fe835674SShri Abhyankar       }
1941fe835674SShri Abhyankar       if PetscIsInfOrNanReal(*gnorm) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FP,"User provided compute function generated a Not-a-Number");
1942fe835674SShri Abhyankar       ierr = VecNormBegin(y,NORM_2,ynorm);CHKERRQ(ierr);
1943fe835674SShri Abhyankar       ierr = VecNormEnd(y,NORM_2,ynorm);CHKERRQ(ierr);
1944fe835674SShri Abhyankar     }
1945fe835674SShri Abhyankar   }
1946fe835674SShri Abhyankar   ierr = PetscLogEventEnd(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr);
1947fe835674SShri Abhyankar   PetscFunctionReturn(0);
1948fe835674SShri Abhyankar }
1949fe835674SShri Abhyankar 
19502b4ed282SShri Abhyankar #undef __FUNCT__
19512b4ed282SShri Abhyankar #define __FUNCT__ "SNESLineSearchQuadratic_VI"
19522b4ed282SShri Abhyankar /*
19532b4ed282SShri Abhyankar   This routine is a copy of SNESLineSearchQuadratic in snes/impls/ls/ls.c
19542b4ed282SShri Abhyankar */
1955ace3abfcSBarry 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)
19562b4ed282SShri Abhyankar {
19572b4ed282SShri Abhyankar   /*
19582b4ed282SShri Abhyankar      Note that for line search purposes we work with with the related
19592b4ed282SShri Abhyankar      minimization problem:
19602b4ed282SShri Abhyankar         min  z(x):  R^n -> R,
19612b4ed282SShri Abhyankar      where z(x) = .5 * fnorm*fnorm,and fnorm = || f ||_2.
19622b4ed282SShri Abhyankar      z(x) is the same as the merit function for the complementarity problem
19632b4ed282SShri Abhyankar    */
19642b4ed282SShri Abhyankar   PetscReal      initslope,minlambda,lambda,lambdatemp,rellength;
19652b4ed282SShri Abhyankar #if defined(PETSC_USE_COMPLEX)
19662b4ed282SShri Abhyankar   PetscScalar    cinitslope;
19672b4ed282SShri Abhyankar #endif
19682b4ed282SShri Abhyankar   PetscErrorCode ierr;
19692b4ed282SShri Abhyankar   PetscInt       count;
19702b4ed282SShri Abhyankar   SNES_VI        *vi = (SNES_VI*)snes->data;
1971ace3abfcSBarry Smith   PetscBool     changed_w = PETSC_FALSE,changed_y = PETSC_FALSE;
19722b4ed282SShri Abhyankar 
19732b4ed282SShri Abhyankar   PetscFunctionBegin;
19742b4ed282SShri Abhyankar   ierr    = PetscLogEventBegin(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr);
19752b4ed282SShri Abhyankar   *flag   = PETSC_TRUE;
19762b4ed282SShri Abhyankar 
19772b4ed282SShri Abhyankar   ierr = VecNorm(y,NORM_2,ynorm);CHKERRQ(ierr);
19782b4ed282SShri Abhyankar   if (*ynorm == 0.0) {
1979c92abb8aSShri Abhyankar     if (vi->lsmonitor) {
1980c92abb8aSShri Abhyankar       ierr = PetscViewerASCIIMonitorPrintf(vi->lsmonitor,"Line search: Direction and size is 0\n");CHKERRQ(ierr);
19812b4ed282SShri Abhyankar     }
19822b4ed282SShri Abhyankar     *gnorm = fnorm;
19832b4ed282SShri Abhyankar     ierr   = VecCopy(x,w);CHKERRQ(ierr);
19842b4ed282SShri Abhyankar     ierr   = VecCopy(f,g);CHKERRQ(ierr);
19852b4ed282SShri Abhyankar     *flag  = PETSC_FALSE;
19862b4ed282SShri Abhyankar     goto theend2;
19872b4ed282SShri Abhyankar   }
19882b4ed282SShri Abhyankar   if (*ynorm > vi->maxstep) {	/* Step too big, so scale back */
19892b4ed282SShri Abhyankar     ierr   = VecScale(y,vi->maxstep/(*ynorm));CHKERRQ(ierr);
19902b4ed282SShri Abhyankar     *ynorm = vi->maxstep;
19912b4ed282SShri Abhyankar   }
19922b4ed282SShri Abhyankar   ierr      = VecMaxPointwiseDivide(y,x,&rellength);CHKERRQ(ierr);
19932b4ed282SShri Abhyankar   minlambda = vi->minlambda/rellength;
19942b4ed282SShri Abhyankar #if defined(PETSC_USE_COMPLEX)
199589d9e806SShri Abhyankar   ierr      = VecDot(vi->dpsi,y,&cinitslope);CHKERRQ(ierr);
19962b4ed282SShri Abhyankar   initslope = PetscRealPart(cinitslope);
19972b4ed282SShri Abhyankar #else
199889d9e806SShri Abhyankar   ierr = VecDot(vi->dpsi,y,&initslope);CHKERRQ(ierr);
19992b4ed282SShri Abhyankar #endif
20002b4ed282SShri Abhyankar   if (initslope > 0.0)  initslope = -initslope;
20012b4ed282SShri Abhyankar   if (initslope == 0.0) initslope = -1.0;
20022b4ed282SShri Abhyankar   ierr = PetscInfo1(snes,"Initslope %G \n",initslope);CHKERRQ(ierr);
20032b4ed282SShri Abhyankar 
20042b4ed282SShri Abhyankar   ierr = VecWAXPY(w,-1.0,y,x);CHKERRQ(ierr);
20052b4ed282SShri Abhyankar   if (snes->nfuncs >= snes->max_funcs) {
20062b4ed282SShri Abhyankar     ierr  = PetscInfo(snes,"Exceeded maximum function evaluations, while checking full step length!\n");CHKERRQ(ierr);
20072b4ed282SShri Abhyankar     *flag = PETSC_FALSE;
20082b4ed282SShri Abhyankar     snes->reason = SNES_DIVERGED_FUNCTION_COUNT;
20092b4ed282SShri Abhyankar     goto theend2;
20102b4ed282SShri Abhyankar   }
20112b4ed282SShri Abhyankar   ierr = SNESComputeFunction(snes,w,g);CHKERRQ(ierr);
20122b4ed282SShri Abhyankar   if (snes->domainerror) {
20132b4ed282SShri Abhyankar     ierr = PetscLogEventEnd(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr);
20142b4ed282SShri Abhyankar     PetscFunctionReturn(0);
20152b4ed282SShri Abhyankar   }
20162b4ed282SShri Abhyankar   ierr = VecNorm(g,NORM_2,gnorm);CHKERRQ(ierr);
20172b4ed282SShri Abhyankar   if PetscIsInfOrNanReal(*gnorm) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FP,"User provided compute function generated a Not-a-Number");
20182b4ed282SShri Abhyankar   if (.5*(*gnorm)*(*gnorm) <= .5*fnorm*fnorm + vi->alpha*initslope) { /* Sufficient reduction */
2019c92abb8aSShri Abhyankar     if (vi->lsmonitor) {
2020c92abb8aSShri Abhyankar       ierr = PetscViewerASCIIMonitorPrintf(vi->lsmonitor,"    Line search: Using full step: fnorm %G gnorm %G\n",fnorm,*gnorm);CHKERRQ(ierr);
20212b4ed282SShri Abhyankar     }
20222b4ed282SShri Abhyankar     goto theend2;
20232b4ed282SShri Abhyankar   }
20242b4ed282SShri Abhyankar 
20252b4ed282SShri Abhyankar   /* Fit points with quadratic */
20262b4ed282SShri Abhyankar   lambda = 1.0;
20272b4ed282SShri Abhyankar   count = 1;
20282b4ed282SShri Abhyankar   while (PETSC_TRUE) {
20292b4ed282SShri Abhyankar     if (lambda <= minlambda) { /* bad luck; use full step */
2030c92abb8aSShri Abhyankar       if (vi->lsmonitor) {
2031c92abb8aSShri Abhyankar         ierr = PetscViewerASCIIMonitorPrintf(vi->lsmonitor,"Line search: Unable to find good step length! %D \n",count);CHKERRQ(ierr);
2032c92abb8aSShri 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);
20332b4ed282SShri Abhyankar       }
20342b4ed282SShri Abhyankar       ierr = VecCopy(x,w);CHKERRQ(ierr);
20352b4ed282SShri Abhyankar       *flag = PETSC_FALSE;
20362b4ed282SShri Abhyankar       break;
20372b4ed282SShri Abhyankar     }
20382b4ed282SShri Abhyankar     lambdatemp = -initslope/((*gnorm)*(*gnorm) - fnorm*fnorm - 2.0*initslope);
20392b4ed282SShri Abhyankar     if (lambdatemp > .5*lambda)  lambdatemp = .5*lambda;
20402b4ed282SShri Abhyankar     if (lambdatemp <= .1*lambda) lambda     = .1*lambda;
20412b4ed282SShri Abhyankar     else                         lambda     = lambdatemp;
20422b4ed282SShri Abhyankar 
20432b4ed282SShri Abhyankar     ierr = VecWAXPY(w,-lambda,y,x);CHKERRQ(ierr);
20442b4ed282SShri Abhyankar     if (snes->nfuncs >= snes->max_funcs) {
20452b4ed282SShri Abhyankar       ierr  = PetscInfo1(snes,"Exceeded maximum function evaluations, while looking for good step length! %D \n",count);CHKERRQ(ierr);
20462b4ed282SShri 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);
20472b4ed282SShri Abhyankar       *flag = PETSC_FALSE;
20482b4ed282SShri Abhyankar       snes->reason = SNES_DIVERGED_FUNCTION_COUNT;
20492b4ed282SShri Abhyankar       break;
20502b4ed282SShri Abhyankar     }
20512b4ed282SShri Abhyankar     ierr = SNESComputeFunction(snes,w,g);CHKERRQ(ierr);
20522b4ed282SShri Abhyankar     if (snes->domainerror) {
20532b4ed282SShri Abhyankar       ierr = PetscLogEventEnd(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr);
20542b4ed282SShri Abhyankar       PetscFunctionReturn(0);
20552b4ed282SShri Abhyankar     }
20562b4ed282SShri Abhyankar     ierr = VecNorm(g,NORM_2,gnorm);CHKERRQ(ierr);
20572b4ed282SShri Abhyankar     if PetscIsInfOrNanReal(*gnorm) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FP,"User provided compute function generated a Not-a-Number");
20582b4ed282SShri Abhyankar     if (.5*(*gnorm)*(*gnorm) < .5*fnorm*fnorm + lambda*vi->alpha*initslope) { /* sufficient reduction */
2059c92abb8aSShri Abhyankar       if (vi->lsmonitor) {
2060c92abb8aSShri Abhyankar         ierr = PetscViewerASCIIMonitorPrintf(vi->lsmonitor,"    Line Search: Quadratically determined step, lambda=%G\n",lambda);CHKERRQ(ierr);
20612b4ed282SShri Abhyankar       }
20622b4ed282SShri Abhyankar       break;
20632b4ed282SShri Abhyankar     }
20642b4ed282SShri Abhyankar     count++;
20652b4ed282SShri Abhyankar   }
20662b4ed282SShri Abhyankar   theend2:
20672b4ed282SShri Abhyankar   /* Optional user-defined check for line search step validity */
20682b4ed282SShri Abhyankar   if (vi->postcheckstep) {
20692b4ed282SShri Abhyankar     ierr = (*vi->postcheckstep)(snes,x,y,w,vi->postcheck,&changed_y,&changed_w);CHKERRQ(ierr);
20702b4ed282SShri Abhyankar     if (changed_y) {
20712b4ed282SShri Abhyankar       ierr = VecWAXPY(w,-1.0,y,x);CHKERRQ(ierr);
20722b4ed282SShri Abhyankar     }
20732b4ed282SShri Abhyankar     if (changed_y || changed_w) { /* recompute the function if the step has changed */
20742b4ed282SShri Abhyankar       ierr = SNESComputeFunction(snes,w,g);
20752b4ed282SShri Abhyankar       if (snes->domainerror) {
20762b4ed282SShri Abhyankar         ierr = PetscLogEventEnd(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr);
20772b4ed282SShri Abhyankar         PetscFunctionReturn(0);
20782b4ed282SShri Abhyankar       }
20792b4ed282SShri Abhyankar       ierr = VecNormBegin(g,NORM_2,gnorm);CHKERRQ(ierr);
20802b4ed282SShri Abhyankar       ierr = VecNormBegin(y,NORM_2,ynorm);CHKERRQ(ierr);
20812b4ed282SShri Abhyankar       ierr = VecNormEnd(g,NORM_2,gnorm);CHKERRQ(ierr);
20822b4ed282SShri Abhyankar       ierr = VecNormEnd(y,NORM_2,ynorm);CHKERRQ(ierr);
20832b4ed282SShri Abhyankar       if PetscIsInfOrNanReal(*gnorm) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FP,"User provided compute function generated a Not-a-Number");
20842b4ed282SShri Abhyankar     }
20852b4ed282SShri Abhyankar   }
20862b4ed282SShri Abhyankar   ierr = PetscLogEventEnd(SNES_LineSearch,snes,x,f,g);CHKERRQ(ierr);
20872b4ed282SShri Abhyankar   PetscFunctionReturn(0);
20882b4ed282SShri Abhyankar }
20892b4ed282SShri Abhyankar 
2090ace3abfcSBarry 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*/
20912b4ed282SShri Abhyankar /* -------------------------------------------------------------------------- */
20922b4ed282SShri Abhyankar EXTERN_C_BEGIN
20932b4ed282SShri Abhyankar #undef __FUNCT__
20942b4ed282SShri Abhyankar #define __FUNCT__ "SNESLineSearchSet_VI"
20957087cfbeSBarry Smith PetscErrorCode  SNESLineSearchSet_VI(SNES snes,FCN2 func,void *lsctx)
20962b4ed282SShri Abhyankar {
20972b4ed282SShri Abhyankar   PetscFunctionBegin;
20982b4ed282SShri Abhyankar   ((SNES_VI *)(snes->data))->LineSearch = func;
20992b4ed282SShri Abhyankar   ((SNES_VI *)(snes->data))->lsP        = lsctx;
21002b4ed282SShri Abhyankar   PetscFunctionReturn(0);
21012b4ed282SShri Abhyankar }
21022b4ed282SShri Abhyankar EXTERN_C_END
21032b4ed282SShri Abhyankar 
21042b4ed282SShri Abhyankar /* -------------------------------------------------------------------------- */
21052b4ed282SShri Abhyankar EXTERN_C_BEGIN
21062b4ed282SShri Abhyankar #undef __FUNCT__
21072b4ed282SShri Abhyankar #define __FUNCT__ "SNESLineSearchSetMonitor_VI"
21087087cfbeSBarry Smith PetscErrorCode  SNESLineSearchSetMonitor_VI(SNES snes,PetscBool flg)
21092b4ed282SShri Abhyankar {
21102b4ed282SShri Abhyankar   SNES_VI        *vi = (SNES_VI*)snes->data;
21112b4ed282SShri Abhyankar   PetscErrorCode ierr;
21122b4ed282SShri Abhyankar 
21132b4ed282SShri Abhyankar   PetscFunctionBegin;
2114c92abb8aSShri Abhyankar   if (flg && !vi->lsmonitor) {
2115c92abb8aSShri Abhyankar     ierr = PetscViewerASCIIMonitorCreate(((PetscObject)snes)->comm,"stdout",((PetscObject)snes)->tablevel,&vi->lsmonitor);CHKERRQ(ierr);
2116c92abb8aSShri Abhyankar   } else if (!flg && vi->lsmonitor) {
2117c92abb8aSShri Abhyankar     ierr = PetscViewerASCIIMonitorDestroy(vi->lsmonitor);CHKERRQ(ierr);
21182b4ed282SShri Abhyankar   }
21192b4ed282SShri Abhyankar   PetscFunctionReturn(0);
21202b4ed282SShri Abhyankar }
21212b4ed282SShri Abhyankar EXTERN_C_END
21222b4ed282SShri Abhyankar 
21232b4ed282SShri Abhyankar /*
21242b4ed282SShri Abhyankar    SNESView_VI - Prints info from the SNESVI data structure.
21252b4ed282SShri Abhyankar 
21262b4ed282SShri Abhyankar    Input Parameters:
21272b4ed282SShri Abhyankar .  SNES - the SNES context
21282b4ed282SShri Abhyankar .  viewer - visualization context
21292b4ed282SShri Abhyankar 
21302b4ed282SShri Abhyankar    Application Interface Routine: SNESView()
21312b4ed282SShri Abhyankar */
21322b4ed282SShri Abhyankar #undef __FUNCT__
21332b4ed282SShri Abhyankar #define __FUNCT__ "SNESView_VI"
21342b4ed282SShri Abhyankar static PetscErrorCode SNESView_VI(SNES snes,PetscViewer viewer)
21352b4ed282SShri Abhyankar {
21362b4ed282SShri Abhyankar   SNES_VI        *vi = (SNES_VI *)snes->data;
213778c4b9d3SShri Abhyankar   const char     *cstr,*tstr;
21382b4ed282SShri Abhyankar   PetscErrorCode ierr;
2139ace3abfcSBarry Smith   PetscBool     iascii;
21402b4ed282SShri Abhyankar 
21412b4ed282SShri Abhyankar   PetscFunctionBegin;
21422b4ed282SShri Abhyankar   ierr = PetscTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
21432b4ed282SShri Abhyankar   if (iascii) {
21442b4ed282SShri Abhyankar     if (vi->LineSearch == SNESLineSearchNo_VI)             cstr = "SNESLineSearchNo";
21452b4ed282SShri Abhyankar     else if (vi->LineSearch == SNESLineSearchQuadratic_VI) cstr = "SNESLineSearchQuadratic";
21462b4ed282SShri Abhyankar     else if (vi->LineSearch == SNESLineSearchCubic_VI)     cstr = "SNESLineSearchCubic";
2147fe835674SShri Abhyankar     else if (vi->LineSearch == SNESLineSearchBoundProjectedCubic_VI) cstr = "SNESLineSearchBoundProjectedCubic";
2148*c1a5e521SShri Abhyankar     else if(vi->LineSearch == SNESLineSearchBoundProjectedNo_VI) cstr = "SNESLineSearchBoundProjectedBasic";
21492b4ed282SShri Abhyankar     else                                                cstr = "unknown";
215078c4b9d3SShri Abhyankar     if (snes->ops->solve == SNESSolveVI_SS)      tstr = "Semismooth";
215178c4b9d3SShri Abhyankar     else if (snes->ops->solve == SNESSolveVI_AS)  tstr = "Active Set";
21520a7c7af0SShri Abhyankar     else if (snes->ops->solve == SNESSolveVI_RS) tstr = "Reduced Space";
215378c4b9d3SShri Abhyankar     else                                         tstr = "unknown";
215478c4b9d3SShri Abhyankar     ierr = PetscViewerASCIIPrintf(viewer,"  VI algorithm: %s\n",tstr);CHKERRQ(ierr);
21552b4ed282SShri Abhyankar     ierr = PetscViewerASCIIPrintf(viewer,"  line search variant: %s\n",cstr);CHKERRQ(ierr);
21562b4ed282SShri Abhyankar     ierr = PetscViewerASCIIPrintf(viewer,"  alpha=%G, maxstep=%G, minlambda=%G\n",vi->alpha,vi->maxstep,vi->minlambda);CHKERRQ(ierr);
21572b4ed282SShri Abhyankar   } else {
21582b4ed282SShri Abhyankar     SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Viewer type %s not supported for SNES EQ VI",((PetscObject)viewer)->type_name);
21592b4ed282SShri Abhyankar   }
21602b4ed282SShri Abhyankar   PetscFunctionReturn(0);
21612b4ed282SShri Abhyankar }
21622b4ed282SShri Abhyankar 
21632b4ed282SShri Abhyankar /*
21642b4ed282SShri Abhyankar    SNESVISetVariableBounds - Sets the lower and upper bounds for the solution vector. xl <= x <= xu.
21652b4ed282SShri Abhyankar 
21662b4ed282SShri Abhyankar    Input Parameters:
21672b4ed282SShri Abhyankar .  snes - the SNES context.
21682b4ed282SShri Abhyankar .  xl   - lower bound.
21692b4ed282SShri Abhyankar .  xu   - upper bound.
21702b4ed282SShri Abhyankar 
21712b4ed282SShri Abhyankar    Notes:
21722b4ed282SShri Abhyankar    If this routine is not called then the lower and upper bounds are set to
217384c105d7SBarry Smith    PETSC_VI_INF and PETSC_VI_NINF respectively during SNESSetUp().
217484c105d7SBarry Smith 
21752b4ed282SShri Abhyankar */
21762b4ed282SShri Abhyankar 
21772b4ed282SShri Abhyankar #undef __FUNCT__
21782b4ed282SShri Abhyankar #define __FUNCT__ "SNESVISetVariableBounds"
217969c03620SShri Abhyankar PetscErrorCode SNESVISetVariableBounds(SNES snes, Vec xl, Vec xu)
21802b4ed282SShri Abhyankar {
21812b4ed282SShri Abhyankar   SNES_VI        *vi = (SNES_VI*)snes->data;
21822b4ed282SShri Abhyankar 
21832b4ed282SShri Abhyankar   PetscFunctionBegin;
21842b4ed282SShri Abhyankar   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
21852b4ed282SShri Abhyankar   PetscValidHeaderSpecific(xl,VEC_CLASSID,2);
21862b4ed282SShri Abhyankar   PetscValidHeaderSpecific(xu,VEC_CLASSID,3);
21872b4ed282SShri Abhyankar 
21882b4ed282SShri Abhyankar   /* Check if SNESSetFunction is called */
21892b4ed282SShri Abhyankar   if(!snes->vec_func) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call SNESSetFunction() first");
21902b4ed282SShri Abhyankar 
21912b4ed282SShri Abhyankar   /* Check if the vector sizes are compatible for lower and upper bounds */
21922b4ed282SShri 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);
21932b4ed282SShri 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);
21942b4ed282SShri Abhyankar   vi->usersetxbounds = PETSC_TRUE;
21952b4ed282SShri Abhyankar   vi->xl = xl;
21962b4ed282SShri Abhyankar   vi->xu = xu;
21972b4ed282SShri Abhyankar 
21982b4ed282SShri Abhyankar   PetscFunctionReturn(0);
21992b4ed282SShri Abhyankar }
22002b4ed282SShri Abhyankar /* -------------------------------------------------------------------------- */
22012b4ed282SShri Abhyankar /*
22022b4ed282SShri Abhyankar    SNESSetFromOptions_VI - Sets various parameters for the SNESVI method.
22032b4ed282SShri Abhyankar 
22042b4ed282SShri Abhyankar    Input Parameter:
22052b4ed282SShri Abhyankar .  snes - the SNES context
22062b4ed282SShri Abhyankar 
22072b4ed282SShri Abhyankar    Application Interface Routine: SNESSetFromOptions()
22082b4ed282SShri Abhyankar */
22092b4ed282SShri Abhyankar #undef __FUNCT__
22102b4ed282SShri Abhyankar #define __FUNCT__ "SNESSetFromOptions_VI"
22112b4ed282SShri Abhyankar static PetscErrorCode SNESSetFromOptions_VI(SNES snes)
22122b4ed282SShri Abhyankar {
22132b4ed282SShri Abhyankar   SNES_VI        *vi = (SNES_VI *)snes->data;
2214*c1a5e521SShri Abhyankar   const char     *lses[] = {"basic","basicnonorms","quadratic","cubic","boundproj_basic"};
2215d950fb63SShri Abhyankar   const char     *vies[] = {"ss","as","rs"};
22162b4ed282SShri Abhyankar   PetscErrorCode ierr;
22172b4ed282SShri Abhyankar   PetscInt       indx;
221869c03620SShri Abhyankar   PetscBool      flg,set,flg2;
22192b4ed282SShri Abhyankar 
22202b4ed282SShri Abhyankar   PetscFunctionBegin;
22212b4ed282SShri Abhyankar   ierr = PetscOptionsHead("SNES semismooth method options");CHKERRQ(ierr);
22229308c137SBarry Smith   ierr = PetscOptionsBool("-snes_vi_monitor","Monitor all non-active variables","None",PETSC_FALSE,&flg,0);CHKERRQ(ierr);
22239308c137SBarry Smith   if (flg) {
22249308c137SBarry Smith     ierr = SNESMonitorSet(snes,SNESMonitorVI,0,0);CHKERRQ(ierr);
22259308c137SBarry Smith   }
22262b4ed282SShri Abhyankar   ierr = PetscOptionsReal("-snes_vi_alpha","Function norm must decrease by","None",vi->alpha,&vi->alpha,0);CHKERRQ(ierr);
22272b4ed282SShri Abhyankar   ierr = PetscOptionsReal("-snes_vi_maxstep","Step must be less than","None",vi->maxstep,&vi->maxstep,0);CHKERRQ(ierr);
22282b4ed282SShri Abhyankar   ierr = PetscOptionsReal("-snes_vi_minlambda","Minimum lambda allowed","None",vi->minlambda,&vi->minlambda,0);CHKERRQ(ierr);
22292b4ed282SShri Abhyankar   ierr = PetscOptionsReal("-snes_vi_const_tol","constraint tolerance","None",vi->const_tol,&vi->const_tol,0);CHKERRQ(ierr);
2230acfcf0e5SJed Brown   ierr = PetscOptionsBool("-snes_vi_lsmonitor","Print progress of line searches","SNESLineSearchSetMonitor",vi->lsmonitor ? PETSC_TRUE : PETSC_FALSE,&flg,&set);CHKERRQ(ierr);
22312b4ed282SShri Abhyankar   if (set) {ierr = SNESLineSearchSetMonitor(snes,flg);CHKERRQ(ierr);}
2232d950fb63SShri Abhyankar   ierr = PetscOptionsEList("-snes_vi_type","Semismooth algorithm used","",vies,3,"ss",&indx,&flg2);CHKERRQ(ierr);
223369c03620SShri Abhyankar   if (flg2) {
223469c03620SShri Abhyankar     switch (indx) {
223569c03620SShri Abhyankar     case 0:
223669c03620SShri Abhyankar       snes->ops->solve = SNESSolveVI_SS;
223769c03620SShri Abhyankar       break;
223869c03620SShri Abhyankar     case 1:
223969c03620SShri Abhyankar       snes->ops->solve = SNESSolveVI_AS;
224069c03620SShri Abhyankar       break;
2241d950fb63SShri Abhyankar     case 2:
2242d950fb63SShri Abhyankar       snes->ops->solve = SNESSolveVI_RS;
2243d950fb63SShri Abhyankar       break;
224469c03620SShri Abhyankar     }
224569c03620SShri Abhyankar   }
2246fe835674SShri Abhyankar   if (snes->ops->solve == SNESSolveVI_RS) {
2247fe835674SShri Abhyankar     ierr = SNESLineSearchSet(snes,SNESLineSearchBoundProjectedCubic_VI,PETSC_NULL);CHKERRQ(ierr);
2248fe835674SShri Abhyankar   }
2249fe835674SShri Abhyankar   else {
2250*c1a5e521SShri Abhyankar     ierr = PetscOptionsEList("-snes_vi_ls","Line search used","SNESLineSearchSet",lses,5,"boundproj_basic",&indx,&flg);CHKERRQ(ierr);
22512b4ed282SShri Abhyankar     if (flg) {
22522b4ed282SShri Abhyankar       switch (indx) {
22532b4ed282SShri Abhyankar       case 0:
22542b4ed282SShri Abhyankar         ierr = SNESLineSearchSet(snes,SNESLineSearchNo_VI,PETSC_NULL);CHKERRQ(ierr);
22552b4ed282SShri Abhyankar         break;
22562b4ed282SShri Abhyankar       case 1:
22572b4ed282SShri Abhyankar         ierr = SNESLineSearchSet(snes,SNESLineSearchNoNorms_VI,PETSC_NULL);CHKERRQ(ierr);
22582b4ed282SShri Abhyankar         break;
22592b4ed282SShri Abhyankar       case 2:
22602b4ed282SShri Abhyankar         ierr = SNESLineSearchSet(snes,SNESLineSearchQuadratic_VI,PETSC_NULL);CHKERRQ(ierr);
22612b4ed282SShri Abhyankar         break;
22622b4ed282SShri Abhyankar       case 3:
22632b4ed282SShri Abhyankar         ierr = SNESLineSearchSet(snes,SNESLineSearchCubic_VI,PETSC_NULL);CHKERRQ(ierr);
22642b4ed282SShri Abhyankar         break;
2265*c1a5e521SShri Abhyankar       case 4:
2266*c1a5e521SShri Abhyankar         ierr = SNESLineSearchSet(snes,SNESLineSearchBoundProjectedNo_VI,PETSC_NULL);CHKERRQ(ierr);
2267*c1a5e521SShri Abhyankar         break;
22682b4ed282SShri Abhyankar       }
22692b4ed282SShri Abhyankar     }
2270fe835674SShri Abhyankar   }
22712b4ed282SShri Abhyankar   ierr = PetscOptionsTail();CHKERRQ(ierr);
22722b4ed282SShri Abhyankar   PetscFunctionReturn(0);
22732b4ed282SShri Abhyankar }
22742b4ed282SShri Abhyankar /* -------------------------------------------------------------------------- */
22752b4ed282SShri Abhyankar /*MC
22762b4ed282SShri Abhyankar       SNESVI - Semismooth newton method based nonlinear solver that uses a line search
22772b4ed282SShri Abhyankar 
22782b4ed282SShri Abhyankar    Options Database:
22792b4ed282SShri Abhyankar +   -snes_vi [cubic,quadratic,basic,basicnonorms] - Selects line search
22802b4ed282SShri Abhyankar .   -snes_vi_alpha <alpha> - Sets alpha
22812b4ed282SShri 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)
22822b4ed282SShri Abhyankar .   -snes_vi_minlambda <minlambda>  - Sets the minimum lambda the line search will use  minlambda / max_i ( y[i]/x[i] )
22832b4ed282SShri Abhyankar -   -snes_vi_monitor - print information about progress of line searches
22842b4ed282SShri Abhyankar 
22852b4ed282SShri Abhyankar 
22862b4ed282SShri Abhyankar    Level: beginner
22872b4ed282SShri Abhyankar 
22882b4ed282SShri Abhyankar .seealso:  SNESCreate(), SNES, SNESSetType(), SNESTR, SNESLineSearchSet(),
22892b4ed282SShri Abhyankar            SNESLineSearchSetPostCheck(), SNESLineSearchNo(), SNESLineSearchCubic(), SNESLineSearchQuadratic(),
22902b4ed282SShri Abhyankar            SNESLineSearchSet(), SNESLineSearchNoNorms(), SNESLineSearchSetPreCheck(), SNESLineSearchSetParams(), SNESLineSearchGetParams()
22912b4ed282SShri Abhyankar 
22922b4ed282SShri Abhyankar M*/
22932b4ed282SShri Abhyankar EXTERN_C_BEGIN
22942b4ed282SShri Abhyankar #undef __FUNCT__
22952b4ed282SShri Abhyankar #define __FUNCT__ "SNESCreate_VI"
22967087cfbeSBarry Smith PetscErrorCode  SNESCreate_VI(SNES snes)
22972b4ed282SShri Abhyankar {
22982b4ed282SShri Abhyankar   PetscErrorCode ierr;
22992b4ed282SShri Abhyankar   SNES_VI      *vi;
23002b4ed282SShri Abhyankar 
23012b4ed282SShri Abhyankar   PetscFunctionBegin;
23022b4ed282SShri Abhyankar   snes->ops->setup	     = SNESSetUp_VI;
230369c03620SShri Abhyankar   snes->ops->solve	     = SNESSolveVI_SS;
23042b4ed282SShri Abhyankar   snes->ops->destroy	     = SNESDestroy_VI;
23052b4ed282SShri Abhyankar   snes->ops->setfromoptions  = SNESSetFromOptions_VI;
23062b4ed282SShri Abhyankar   snes->ops->view            = SNESView_VI;
23072b4ed282SShri Abhyankar   snes->ops->converged       = SNESDefaultConverged_VI;
23082b4ed282SShri Abhyankar 
23092b4ed282SShri Abhyankar   ierr                   = PetscNewLog(snes,SNES_VI,&vi);CHKERRQ(ierr);
23102b4ed282SShri Abhyankar   snes->data    	 = (void*)vi;
23112b4ed282SShri Abhyankar   vi->alpha		 = 1.e-4;
23122b4ed282SShri Abhyankar   vi->maxstep		 = 1.e8;
23132b4ed282SShri Abhyankar   vi->minlambda         = 1.e-12;
2314*c1a5e521SShri Abhyankar   vi->LineSearch        = SNESLineSearchBoundProjectedNo_VI;
23152b4ed282SShri Abhyankar   vi->lsP               = PETSC_NULL;
23162b4ed282SShri Abhyankar   vi->postcheckstep     = PETSC_NULL;
23172b4ed282SShri Abhyankar   vi->postcheck         = PETSC_NULL;
23182b4ed282SShri Abhyankar   vi->precheckstep      = PETSC_NULL;
23192b4ed282SShri Abhyankar   vi->precheck          = PETSC_NULL;
23202b4ed282SShri Abhyankar   vi->const_tol         =  2.2204460492503131e-16;
23212b4ed282SShri Abhyankar   vi->computessfunction = ComputeFischerFunction;
23222b4ed282SShri Abhyankar 
23232b4ed282SShri Abhyankar   ierr = PetscObjectComposeFunctionDynamic((PetscObject)snes,"SNESLineSearchSetMonitor_C","SNESLineSearchSetMonitor_VI",SNESLineSearchSetMonitor_VI);CHKERRQ(ierr);
23242b4ed282SShri Abhyankar   ierr = PetscObjectComposeFunctionDynamic((PetscObject)snes,"SNESLineSearchSet_C","SNESLineSearchSet_VI",SNESLineSearchSet_VI);CHKERRQ(ierr);
23252b4ed282SShri Abhyankar 
23262b4ed282SShri Abhyankar   PetscFunctionReturn(0);
23272b4ed282SShri Abhyankar }
23282b4ed282SShri Abhyankar EXTERN_C_END
2329