AnasaziLOBPCGSolMgr.hpp

Go to the documentation of this file.

// @HEADER
// ***********************************************************************
//
//                 Anasazi: Block Eigensolvers Package
//                 Copyright (2004) Sandia Corporation
//
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
//
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 2.1 of the
// License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA
// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
//
// ***********************************************************************
// @HEADER

#ifndef ANASAZI_LOBPCG_SOLMGR_HPP
#define ANASAZI_LOBPCG_SOLMGR_HPP

#include "AnasaziConfigDefs.hpp"
#include "AnasaziTypes.hpp"

#include "AnasaziEigenproblem.hpp"
#include "AnasaziSolverManager.hpp"

#include "AnasaziLOBPCG.hpp"
#include "AnasaziBasicSort.hpp"
#include "AnasaziSVQBOrthoManager.hpp"
#include "AnasaziStatusTestMaxIters.hpp"
#include "AnasaziStatusTestResNorm.hpp"
#include "AnasaziStatusTestOrderedResNorm.hpp"
#include "AnasaziStatusTestCombo.hpp"
#include "AnasaziStatusTestOutput.hpp"
#include "AnasaziBasicOutputManager.hpp"


namespace Anasazi {

template<class ScalarType, class MV, class OP>
class LOBPCGSolMgr : public SolverManager<ScalarType,MV,OP> {

  private:
    typedef MultiVecTraits<ScalarType,MV> MVT;
    typedef OperatorTraits<ScalarType,MV,OP> OPT;
    typedef Teuchos::ScalarTraits<ScalarType> SCT;
    typedef typename Teuchos::ScalarTraits<ScalarType>::magnitudeType MagnitudeType;
    typedef Teuchos::ScalarTraits<MagnitudeType> MT;
    
  public:



  LOBPCGSolMgr( const Teuchos::RefCountPtr<Eigenproblem<ScalarType,MV,OP> > &problem,
                             Teuchos::ParameterList &pl );

  virtual ~LOBPCGSolMgr() {};
  


  const Eigenproblem<ScalarType,MV,OP>& getProblem() const {
    return *problem_;
  }



    
  ReturnType solve();

  private:
  Teuchos::RefCountPtr<Eigenproblem<ScalarType,MV,OP> > problem_;

  string whch_; 

  MagnitudeType convtol_, locktol_;
  int maxIters_;
  bool useLocking_;
  bool relconvtol_, rellocktol_;
  int blockSize_;
  bool fullOrtho_;
  int maxLocked_;
  int verbosity_;
  int lockQuorum_;
  bool recover_;
  Teuchos::RefCountPtr<LOBPCGState<ScalarType,MV> > state_;
};


// Constructor
template<class ScalarType, class MV, class OP>
LOBPCGSolMgr<ScalarType,MV,OP>::LOBPCGSolMgr( 
        const Teuchos::RefCountPtr<Eigenproblem<ScalarType,MV,OP> > &problem,
        Teuchos::ParameterList &pl ) : 
  problem_(problem),
  whch_("SR"),
  convtol_(MT::prec()),
  maxIters_(100),
  useLocking_(false),
  relconvtol_(true),
  rellocktol_(true),
  blockSize_(0),
  fullOrtho_(true),
  maxLocked_(0),
  verbosity_(Anasazi::Errors),
  lockQuorum_(1),
  recover_(true)
{
  TEST_FOR_EXCEPTION(problem_ == Teuchos::null,              std::invalid_argument, "Problem not given to solver manager.");
  TEST_FOR_EXCEPTION(!problem_->isProblemSet(),              std::invalid_argument, "Problem not set.");
  TEST_FOR_EXCEPTION(!problem_->isHermitian(),               std::invalid_argument, "Problem not symmetric.");
  TEST_FOR_EXCEPTION(problem_->getInitVec() == Teuchos::null,std::invalid_argument, "Problem does not contain initial vectors to clone from.");


  // which values to solve for
  whch_ = pl.get("Which",whch_);
  TEST_FOR_EXCEPTION(whch_ != "SM" && whch_ != "LM" && whch_ != "SR" && whch_ != "LR",std::invalid_argument, "Invalid sorting string.");

  // convergence tolerance
  convtol_ = pl.get("Convergence Tolerance",convtol_);
  relconvtol_ = pl.get("Relative Convergence Tolerance",relconvtol_);
  
  // locking tolerance
  useLocking_ = pl.get("Use Locking",useLocking_);
  rellocktol_ = pl.get("Relative Locking Tolerance",rellocktol_);
  // default: should be less than convtol_
  locktol_ = convtol_/10;
  locktol_ = pl.get("Locking Tolerance",locktol_);

  // maximum number of iterations
  maxIters_ = pl.get("Maximum Iterations",maxIters_);

  // block size: default is nev()
  blockSize_ = pl.get("Block Size",problem_->getNEV());
  TEST_FOR_EXCEPTION(blockSize_ <= 0, std::invalid_argument,
                     "Anasazi::LOBPCGSolMgr: \"Block Size\" must be strictly positive.");

  // max locked: default is nev(), must satisfy maxLocked_ + blockSize_ >= nev
  if (useLocking_) {
    maxLocked_ = pl.get("Max Locked",problem_->getNEV());
  }
  else {
    maxLocked_ = 0;
  }
  if (maxLocked_ == 0) {
    useLocking_ = false;
  }
  TEST_FOR_EXCEPTION(maxLocked_ < 0, std::invalid_argument,
                     "Anasazi::LOBPCGSolMgr: \"Max Locked\" must be positive.");
  TEST_FOR_EXCEPTION(maxLocked_ + blockSize_ < problem_->getNEV(), 
                     std::invalid_argument,
                     "Anasazi::LOBPCGSolMgr: Not enough storage space for requested number of eigenpairs.");

  if (useLocking_) {
    lockQuorum_ = pl.get("Locking Quorum",lockQuorum_);
    TEST_FOR_EXCEPTION(lockQuorum_ <= 0,
                       std::invalid_argument,
                       "Anasazi::LOBPCGSolMgr: \"Locking Quorum\" must be strictly positive.");
  }

  // full orthogonalization: default true
  fullOrtho_ = pl.get("Full Ortho",fullOrtho_);

  // verbosity level
  if (pl.isParameter("Verbosity")) {
    if (Teuchos::isParameterType<int>(pl,"Verbosity")) {
      verbosity_ = pl.get("Verbosity", verbosity_);
    } else {
      verbosity_ = (int)Teuchos::getParameter<Anasazi::MsgType>(pl,"Verbosity");
    }
  }

  // recover from LOBPCGRitzFailure
  recover_ = pl.get("Recover",recover_);

  // get (optionally) an initial state
  if (pl.isParameter("Init")) {
    state_ = Teuchos::getParameter<Teuchos::RefCountPtr<Anasazi::LOBPCGState<ScalarType,MV> > >(pl,"Init");
  }
}


// solve()
template<class ScalarType, class MV, class OP>
ReturnType 
LOBPCGSolMgr<ScalarType,MV,OP>::solve() {

  const int nev = problem_->getNEV();



  // Sort manager
  Teuchos::RefCountPtr<BasicSort<ScalarType,MV,OP> > sorter = Teuchos::rcp( new BasicSort<ScalarType,MV,OP>(whch_) );

  // Output manager
  Teuchos::RefCountPtr<BasicOutputManager<ScalarType> > printer = Teuchos::rcp( new BasicOutputManager<ScalarType>(verbosity_) );

  // Status tests
  //
  // maximum number of iterations: optional test
  Teuchos::RefCountPtr<StatusTestMaxIters<ScalarType,MV,OP> > maxtest;
  if (maxIters_ > 0) {
    maxtest = Teuchos::rcp( new StatusTestMaxIters<ScalarType,MV,OP>(maxIters_) );
  }
  // convergence
  Teuchos::RefCountPtr<StatusTestOrderedResNorm<ScalarType,MV,OP> > convtest 
      = Teuchos::rcp( new StatusTestOrderedResNorm<ScalarType,MV,OP>(sorter,convtol_,nev,StatusTestOrderedResNorm<ScalarType,MV,OP>::RES_ORTH,relconvtol_) );
  // locking
  Teuchos::RefCountPtr<StatusTestResNorm<ScalarType,MV,OP> > locktest;
  if (useLocking_) {
    locktest = Teuchos::rcp( new StatusTestResNorm<ScalarType,MV,OP>(locktol_,lockQuorum_,StatusTestResNorm<ScalarType,MV,OP>::RES_ORTH,rellocktol_) );
  }
  Teuchos::Array<Teuchos::RefCountPtr<StatusTest<ScalarType,MV,OP> > > alltests;
  // for an OR test, the order doesn't matter
  alltests.push_back(convtest);
  if (maxtest != Teuchos::null) alltests.push_back(maxtest);
  if (locktest != Teuchos::null)   alltests.push_back(locktest);
  // combo: convergence || locking || max iters
  Teuchos::RefCountPtr<StatusTestCombo<ScalarType,MV,OP> > combotest
    = Teuchos::rcp( new StatusTestCombo<ScalarType,MV,OP>( StatusTestCombo<ScalarType,MV,OP>::OR, alltests) );
  // printing StatusTest
  Teuchos::RefCountPtr<StatusTestOutput<ScalarType,MV,OP> > outputtest;
  if ( printer->isVerbosity(Debug) ) {
    outputtest = Teuchos::rcp( new StatusTestOutput<ScalarType,MV,OP>( printer,combotest,1,Passed+Failed+Undefined ) );
  }
  else {
    outputtest = Teuchos::rcp( new StatusTestOutput<ScalarType,MV,OP>( printer,combotest,1,Passed ) );
  }

  // Orthomanager
  Teuchos::RefCountPtr<SVQBOrthoManager<ScalarType,MV,OP> > ortho 
    = Teuchos::rcp( new SVQBOrthoManager<ScalarType,MV,OP>(problem_->getM()) );

  // Parameter list
  Teuchos::ParameterList plist;
  plist.set("Block Size",blockSize_);
  plist.set("Full Ortho",fullOrtho_);

  // utils
  ModalSolverUtils<ScalarType,MV,OP> msutils(printer);

  // LOBPCG solver
  Teuchos::RefCountPtr<LOBPCG<ScalarType,MV,OP> > lobpcg_solver 
    = Teuchos::rcp( new LOBPCG<ScalarType,MV,OP>(problem_,sorter,printer,outputtest,ortho,plist) );
  // set any auxiliary vectors defined in the problem
  Teuchos::RefCountPtr< const MV > probauxvecs = problem_->getAuxVecs();
  if (probauxvecs != Teuchos::null) {
    lobpcg_solver->setAuxVecs( Teuchos::tuple< Teuchos::RefCountPtr<const MV> >(probauxvecs) );
  }

  // Storage
  // 
  // lockvecs will contain eigenvectors that have been determined "locked" by the status test
  int numlocked = 0;
  Teuchos::RefCountPtr<MV> lockvecs;
  if (useLocking_) {
    lockvecs = MVT::Clone(*problem_->getInitVec(),maxLocked_);
  }
  std::vector<MagnitudeType> lockvals;
  // workMV will be used as work space for LOBPCGRitzFailure recovery and locking
  // it will be partitioned in these cases as follows:
  // for LOBPCGRitzFailure recovery:
  // workMV = [X H P OpX OpH OpP], where OpX OpH OpP will be used for K and M
  // total size: 2*3*blocksize
  // for locking
  // workMV = [X P MX MP], with MX,MP needing storage only if hasM==true
  // total size: 2*blocksize or 4*blocksize
  Teuchos::RefCountPtr<MV> workMV;
  if (fullOrtho_ == false && recover_ == true) {
    workMV = MVT::Clone(*problem_->getInitVec(),2*3*blockSize_);
  }
  else if (useLocking_) {
    if (problem_->getM() != Teuchos::null) {
      workMV = MVT::Clone(*problem_->getInitVec(),4*blockSize_);
    }
    else {
      workMV = MVT::Clone(*problem_->getInitVec(),2*blockSize_);
    }
  }

  // initialize the solution to nothing in case we throw an exception
  Eigensolution<ScalarType,MV> sol;
  sol.numVecs = 0;
  problem_->setSolution(sol);

  // initialize the solver if the user specified a state
  if (state_ != Teuchos::null) {
    lobpcg_solver->initialize(*state_);
  }

  // tell the lobpcg_solver to iterate
  while (1) {
    try {
      lobpcg_solver->iterate();

      // check convergence first
      if (convtest->getStatus() == Passed || (maxtest != Teuchos::null && maxtest->getStatus() == Passed) ) {
        // we have convergence or not
        // convtest->whichVecs() tells us which vectors from lockvecs and solver->getRitzVectors() are the ones we want
        // convtest->howMany() will tell us how many
        break;
      }
      // check locking if we didn't converge
      else if (locktest != Teuchos::null && locktest->getStatus() == Passed) {

        // remove the locked vectors,values from lobpcg_solver: put them in newvecs, newvals
        int numnew = locktest->howMany();
        TEST_FOR_EXCEPTION(numnew <= 0,std::logic_error,"Anasazi::LOBPCGSolMgr::solve(): status test mistake.");
        // get the indices
        std::vector<int> indnew = locktest->whichVecs();

        // don't lock more than maxLocked_; we didn't allocate enough space.
        if (numlocked + numnew > maxLocked_) {
          numnew = maxLocked_ - numlocked;
          indnew.resize(numnew);
        }

        // the call below to lobpcg_solver->setAuxVecs() will reset the solver to unitialized with hasP() == false
        // store the hasP() state for use below
        bool hadP = lobpcg_solver->hasP();

        {
          // debug printing
          printer->print(Debug,"Locking vectors: ");
          for (unsigned int i=0; i<indnew.size(); i++) {printer->stream(Debug) << " " << indnew[i];}
          printer->print(Debug,"\n");
        }
        std::vector<MagnitudeType> newvals(numnew);
        Teuchos::RefCountPtr<const MV> newvecs;
        {
          // work in a local scope, to hide the variabes needed for extracting this info
          // get the vectors
          newvecs = MVT::CloneView(*lobpcg_solver->getRitzVectors(),indnew);
          // get the values
          std::vector<Value<ScalarType> > allvals = lobpcg_solver->getRitzValues();
          for (int i=0; i<numnew; i++) {
            newvals[i] = allvals[indnew[i]].realpart;
          }
        }
        // put newvecs into lockvecs
        {
          std::vector<int> indlock(numnew);
          for (int i=0; i<numnew; i++) indlock[i] = numlocked+i;
          MVT::SetBlock(*newvecs,indlock,*lockvecs);
          newvecs = Teuchos::null;
        }
        // put newvals into lockvals
        lockvals.insert(lockvals.end(),newvals.begin(),newvals.end());
        numlocked += numnew;
        // add locked vecs as aux vecs, along with aux vecs from problem
        {
          std::vector<int> indlock(numlocked);
          for (int i=0; i<numlocked; i++) indlock[i] = i;
          Teuchos::RefCountPtr<const MV> curlocked = MVT::CloneView(*lockvecs,indlock);
          if (probauxvecs != Teuchos::null) {
            lobpcg_solver->setAuxVecs( Teuchos::tuple< Teuchos::RefCountPtr<const MV> >(probauxvecs,curlocked) );
          }
          else {
            lobpcg_solver->setAuxVecs( Teuchos::tuple< Teuchos::RefCountPtr<const MV> >(curlocked) );
          }
        }
        // add locked vals to convtest
        convtest->setAuxVals(lockvals);
        // fill out the empty state in the solver
        {
          LOBPCGState<ScalarType,MV> state = lobpcg_solver->getState();
          Teuchos::RefCountPtr<MV> newstateX, newstateMX, newstateP, newstateMP;
          //
          // workMV will be partitioned as follows: workMV = [X P MX MP], 
          //
          // make a copy of the current X,MX state
          std::vector<int> bsind(blockSize_); 
          for (int i=0; i<blockSize_; i++) bsind[i] = i;
          newstateX = MVT::CloneView(*workMV,bsind);
          MVT::SetBlock(*state.X,bsind,*newstateX);

          if (state.MX != Teuchos::null) {
            std::vector<int> block3(blockSize_);
            for (int i=0; i<blockSize_; i++) block3[i] = 2*blockSize_+i;
            newstateMX = MVT::CloneView(*workMV,block3);
            MVT::SetBlock(*state.MX,bsind,*newstateMX);
          }
          //
          // get select part, set to random, apply M
          {
            Teuchos::RefCountPtr<MV> newX = MVT::CloneView(*newstateX,indnew);
            MVT::MvRandom(*newX);

            if (newstateMX != Teuchos::null) {
              Teuchos::RefCountPtr<MV> newMX = MVT::CloneView(*newstateMX,indnew);
              OPT::Apply(*problem_->getM(),*newX,*newMX);
            }
          }

          Teuchos::Array<Teuchos::RefCountPtr<const MV> > curauxvecs = lobpcg_solver->getAuxVecs();
          Teuchos::Array<Teuchos::RefCountPtr<Teuchos::SerialDenseMatrix<int,ScalarType> > > dummy;
          // ortho X against the aux vectors
          ortho->projectAndNormalize(*newstateX,newstateMX,dummy,Teuchos::null,curauxvecs);

          if (hadP) {
            //
            // get P and optionally MP, orthogonalize against X and auxiliary vectors
            std::vector<int> block2(blockSize_);
            for (int i=0; i<blockSize_; i++) block2[i] = blockSize_+i;
            newstateP = MVT::CloneView(*workMV,block2);
            MVT::SetBlock(*state.P,bsind,*newstateP);

            if (state.MP != Teuchos::null) {
              std::vector<int> block4(blockSize_);
              for (int i=0; i<blockSize_; i++) block4[i] = 3*blockSize_+i;
              newstateMP = MVT::CloneView(*workMV,block4);
              MVT::SetBlock(*state.MP,bsind,*newstateMP);
            }

            if (fullOrtho_) {
              // ortho P against the new aux vectors and new X
              curauxvecs.push_back(newstateX);
              ortho->projectAndNormalize(*newstateP,newstateMP,dummy,Teuchos::null,curauxvecs);
            }
            else {
              // ortho P against the new aux vectors
              ortho->projectAndNormalize(*newstateP,newstateMP,dummy,Teuchos::null,curauxvecs);
            }
          }
          // set the new state
          LOBPCGState<ScalarType,MV> newstate;
          newstate.X  = newstateX;
          newstate.MX = newstateMX;
          newstate.P  = newstateP;
          newstate.MP = newstateMP;
          lobpcg_solver->initialize(newstate);
        }

        if (numlocked == maxLocked_) {
          // disabled locking now
          locktest->setQuorum(blockSize_+1);
        }
      }
      else {
        TEST_FOR_EXCEPTION(true,std::logic_error,"Anasazi::LOBPCGSolMgr::solve(): Invalid return from lobpcg_solver::iterate().");
      }
    }
    catch (LOBPCGRitzFailure re) {
      if (fullOrtho_==true || recover_==false) {
        // if we are already using full orthogonalization, there isn't much we can do here. 
        // the most recent information in the status tests is still valid, and can be used to extract/return the 
        // eigenpairs that have converged.
        printer->stream(Warnings) << "Error! Caught LOBPCGRitzFailure at iteration " << lobpcg_solver->getNumIters() << endl
                                << "Will not try to recover." << endl;
        break; // while(1)
      }
      printer->stream(Warnings) << "Error! Caught LOBPCGRitzFailure at iteration " << lobpcg_solver->getNumIters() << endl
                              << "Full orthogonalization is off; will try to recover." << endl;
      // get the current "basis" from the solver, orthonormalize it, do a rayleigh-ritz, and restart with the ritz vectors
      // if there aren't enough, break and quit with what we have
      //
      // workMV = [X H P OpX OpH OpP], where OpX OpH OpP will be used for K and M
      LOBPCGState<ScalarType,MV> curstate = lobpcg_solver->getState();
      Teuchos::RefCountPtr<MV> restart, Krestart, Mrestart;
      int localsize = lobpcg_solver->hasP() ? 3*blockSize_ : 2*blockSize_;
      bool hasM = problem_->getM() != Teuchos::null;
      {
        std::vector<int> recind(localsize);
        for (int i=0; i<localsize; i++) recind[i] = i;
        restart = MVT::CloneView(*workMV,recind);
      }
      {
        std::vector<int> recind(localsize);
        for (int i=0; i<localsize; i++) recind[i] = localsize+i;
        Krestart = MVT::CloneView(*workMV,recind);
      }
      if (hasM) {
        Mrestart = Krestart;
      }
      else {
        Mrestart = restart;
      }
      //
      // set restart = [X H P] and Mrestart = M*[X H P]
      //
      // put X into [0 , blockSize)
      {
        std::vector<int> blk1(blockSize_);
        for (int i=0; i < blockSize_; i++) blk1[i] = i;
        MVT::SetBlock(*curstate.X,blk1,*restart);

        // put MX into [0 , blockSize)
        if (hasM) {
          MVT::SetBlock(*curstate.MX,blk1,*Mrestart);
        }
      }
      //
      // put H into [blockSize_ , 2*blockSize)
      {
        std::vector<int> blk2(blockSize_);
        for (int i=0; i < blockSize_; i++) blk2[i] = blockSize_+i;
        MVT::SetBlock(*curstate.H,blk2,*restart);

        // put MH into [blockSize_ , 2*blockSize)
        if (hasM) {
          MVT::SetBlock(*curstate.MH,blk2,*Mrestart);
        }
      }
      // optionally, put P into [2*blockSize,3*blockSize)
      if (localsize == 3*blockSize_) {
        std::vector<int> blk3(blockSize_);
        for (int i=0; i < blockSize_; i++) blk3[i] = 2*blockSize_+i;
        MVT::SetBlock(*curstate.P,blk3,*restart);

        // put MP into [2*blockSize,3*blockSize)
        if (hasM) {
          MVT::SetBlock(*curstate.MP,blk3,*Mrestart);
        }
      }
      // project against auxvecs and locked vecs, and orthonormalize the basis
      Teuchos::Array<Teuchos::RefCountPtr<Teuchos::SerialDenseMatrix<int,ScalarType> > > dummy;
      Teuchos::Array<Teuchos::RefCountPtr<const MV> > Q;
      {
        if (numlocked > 0) {
          std::vector<int> indlock(numlocked);
          for (int i=0; i<numlocked; i++) indlock[i] = i;
          Teuchos::RefCountPtr<const MV> curlocked = MVT::CloneView(*lockvecs,indlock);
          Q.push_back(curlocked);
        }
        if (probauxvecs != Teuchos::null) {
          Q.push_back(probauxvecs);
        }
      }
      int rank = ortho->projectAndNormalize(*restart,Mrestart,dummy,Teuchos::null,Q);
      if (rank < blockSize_) {
        // quit
        printer->stream(Errors) << "Error! Recovered basis only rank " << rank << ". Block size is " << blockSize_ << ".\n"
                                << "Recovery failed." << endl;
        break;
      }
      // reduce multivec size if necessary
      if (rank < localsize) {
        localsize = rank;
        std::vector<int> redind(localsize);
        for (int i=0; i<localsize; i++) redind[i] = i;
        // grab the first part of restart,Krestart
        restart = MVT::CloneView(*restart,redind);
        Krestart = MVT::CloneView(*Krestart,redind);
        if (hasM) {
          Mrestart = Krestart;
        }
        else {
          Mrestart = restart;
        }
      }
      Teuchos::SerialDenseMatrix<int,ScalarType> KK(localsize,localsize), MM(localsize,localsize), S(localsize,localsize);
      std::vector<MagnitudeType> theta(localsize);
      // project the matrices
      //
      // MM = restart^H M restart
      MVT::MvTransMv(1.0,*restart,*Mrestart,MM);
      // 
      // compute Krestart = K*restart
      OPT::Apply(*problem_->getOperator(),*restart,*Krestart);
      //
      // KK = restart^H K restart
      MVT::MvTransMv(1.0,*restart,*Krestart,KK);
      rank = localsize;
      msutils.directSolver(localsize,KK,&MM,&S,&theta,&rank,1);
      if (rank < blockSize_) {
        printer->stream(Errors) << "Error! Recovered basis of rank " << rank << " produced only " << rank << "ritz vectors.\n"
                                << "Block size is " << blockSize_ << ".\n"
                                << "Recovery failed." << endl;
        break;
      }
      theta.resize(rank);
      //
      // sort the ritz values using the sort manager
      {
        Teuchos::BLAS<int,ScalarType> blas;
        std::vector<int> order(rank);
        // sort
        sorter->sort( lobpcg_solver.get(), rank, theta, &order );   // don't catch exception
        // Sort the primitive ritz vectors
        Teuchos::SerialDenseMatrix<int,ScalarType> curS(Teuchos::View,S,rank,rank);
        msutils.permuteVectors(order,curS);
      }
      //
      Teuchos::SerialDenseMatrix<int,ScalarType> S1(Teuchos::View,S,localsize,blockSize_);
      //
      // compute the ritz vectors: store them in Krestart
      LOBPCGState<ScalarType,MV> newstate;
      Teuchos::RefCountPtr<MV> newX; 
      {
        std::vector<int> bsind(blockSize_);
        for (int i=0; i<blockSize_; i++) bsind[i] = i;
        newX = MVT::CloneView(*Krestart,bsind);
      }
      MVT::MvTimesMatAddMv(1.0,*restart,S1,0.0,*newX);
      // send X and theta into the solver
      newstate.X = newX;
      theta.resize(blockSize_);
      newstate.T = Teuchos::rcp( &theta, false );
      // initialize
      lobpcg_solver->initialize(newstate);
    }
    // don't catch any other exceptions
  }

  sol.numVecs = convtest->howMany();
  if (sol.numVecs > 0) {
    sol.Evecs = MVT::Clone(*problem_->getInitVec(),sol.numVecs);
    sol.Espace = sol.Evecs;
    sol.Evals.resize(sol.numVecs);
    std::vector<MagnitudeType> vals(sol.numVecs);

    // copy them into the solution
    std::vector<int> which = convtest->whichVecs();
    // indices between [0,blockSize) refer to vectors/values in the solver
    // indices between [blockSize,blocksize+numlocked) refer to locked vectors/values
    // everything has already been ordered by the solver; we just have to partition the two references
    std::vector<int> inlocked(0), insolver(0);
    for (unsigned int i=0; i<which.size(); i++) {
      if (which[i] < blockSize_) {
        insolver.push_back(which[i]);
      }
      else {
        // sanity check
        TEST_FOR_EXCEPTION(which[i] >= numlocked+blockSize_,std::logic_error,"Anasazi::LOBPCGSolMgr::solve(): indexing mistake.");
        inlocked.push_back(which[i] - blockSize_);
      }
    }

    TEST_FOR_EXCEPTION(insolver.size() + inlocked.size() != (unsigned int)sol.numVecs,std::logic_error,"Anasazi::LOBPCGSolMgr::solve(): indexing mistake.");

    // set the vecs,vals in the solution
    if (insolver.size() > 0) {
      // set vecs
      int lclnum = insolver.size();
      std::vector<int> tosol(lclnum);
      for (int i=0; i<lclnum; i++) tosol[i] = i;
      Teuchos::RefCountPtr<const MV> v = MVT::CloneView(*lobpcg_solver->getRitzVectors(),insolver);
      MVT::SetBlock(*v,tosol,*sol.Evecs);
      // set vals
      std::vector<Value<ScalarType> > fromsolver = lobpcg_solver->getRitzValues();
      for (unsigned int i=0; i<insolver.size(); i++) {
        vals[i] = fromsolver[insolver[i]].realpart;
      }
    }

    // get the vecs,vals from locked storage
    if (inlocked.size() > 0) {
      int solnum = insolver.size();
      // set vecs
      int lclnum = inlocked.size();
      std::vector<int> tosol(lclnum);
      for (int i=0; i<lclnum; i++) tosol[i] = solnum + i;
      Teuchos::RefCountPtr<const MV> v = MVT::CloneView(*lockvecs,inlocked);
      MVT::SetBlock(*v,tosol,*sol.Evecs);
      // set vals
      for (unsigned int i=0; i<inlocked.size(); i++) {
        vals[i+solnum] = lockvals[inlocked[i]];
      }
    }

    // sort the eigenvalues and permute the eigenvectors appropriately
    {
      std::vector<int> order(sol.numVecs);
      sorter->sort( lobpcg_solver.get(), sol.numVecs, vals, &order );
      // store the values in the Eigensolution
      for (int i=0; i<sol.numVecs; i++) {
        sol.Evals[i].realpart = vals[i];
        sol.Evals[i].imagpart = MT::zero();
      }
      // now permute the eigenvectors according to order
      msutils.permuteVectors(sol.numVecs,order,*sol.Evecs);
    }

    // setup sol.index, remembering that all eigenvalues are real so that index = {0,...,0}
    sol.index.resize(sol.numVecs,0);
  }

  // print final summary
  lobpcg_solver->currentStatus(printer->stream(FinalSummary));

  // print timing information
  Teuchos::TimeMonitor::summarize(printer->stream(TimingDetails));

  problem_->setSolution(sol);
  printer->stream(Debug) << "Returning " << sol.numVecs << " eigenpairs to eigenproblem." << endl;

  if (sol.numVecs < nev) return Unconverged; // return from LOBPCGSolMgr::solve() 
  return Converged; // return from LOBPCGSolMgr::solve() 
}


} // end Anasazi namespace

#endif /* ANASAZI_LOBPCG_SOLMGR_HPP */

---