Anasazi  Version of the Day
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
AnasaziTraceMinSolMgr.hpp
Go to the documentation of this file.
1 // @HEADER
2 // *****************************************************************************
3 // Anasazi: Block Eigensolvers Package
4 //
5 // Copyright 2004 NTESS and the Anasazi contributors.
6 // SPDX-License-Identifier: BSD-3-Clause
7 // *****************************************************************************
8 // @HEADER
9 
10 #ifndef ANASAZI_TRACEMIN_SOLMGR_HPP
11 #define ANASAZI_TRACEMIN_SOLMGR_HPP
12 
19 #include "AnasaziConfigDefs.hpp"
20 #include "AnasaziTypes.hpp"
21 
22 #include "AnasaziEigenproblem.hpp"
23 #include "AnasaziSolverUtils.hpp"
24 
25 #include "AnasaziTraceMin.hpp"
27 #include "AnasaziBasicSort.hpp"
32 #include "AnasaziOutputManager.hpp"
33 #include "Teuchos_BLAS.hpp"
34 #include "Teuchos_LAPACK.hpp"
35 #include "Teuchos_TimeMonitor.hpp"
36 #ifdef TEUCHOS_DEBUG
37 # include <Teuchos_FancyOStream.hpp>
38 #endif
39 
40 namespace Anasazi {
41 namespace Experimental {
42 
43 template<class ScalarType, class MV, class OP>
44 
77 class TraceMinSolMgr : public TraceMinBaseSolMgr<ScalarType,MV,OP> {
78 
79  private:
83  typedef typename Teuchos::ScalarTraits<ScalarType>::magnitudeType MagnitudeType;
85 
86  public:
87 
89 
90 
104 
105  private:
106 
107  int maxits_;
108 
109  // Test whether we have exceeded the maximum number of iterations
110  bool exceededMaxIter() { return (this->iter_ >= maxits_); };
111 
112  // TraceMin does not restart, so this will always return false
113  bool needToRestart(const Teuchos::RCP< TraceMinBase<ScalarType,MV,OP> > solver) { return false; };
114 
115  // TraceMin does not restart, so this will throw an exception
116  bool performRestart(int &numRestarts, Teuchos::RCP< TraceMinBase<ScalarType,MV,OP> > solver)
117  { TEUCHOS_TEST_FOR_EXCEPTION(true, std::logic_error, "Anasazi::TraceMinSolMgr::performRestart(): TraceMin does not perform restarts!"); };
118 
119  // Returns a new TraceMin solver object
122  const Teuchos::RCP<StatusTest<ScalarType,MV,OP> > &outputtest,
125  );
126 };
127 
128 
129 //---------------------------------------------------------------------------//
130 // Prevent instantiation on complex scalar type
131 // FIXME: this really is just a current flaw in the implementation, TraceMin
132 // *should* work for Hermitian matrices
133 //---------------------------------------------------------------------------//
134 template <class MagnitudeType, class MV, class OP>
135 class TraceMinSolMgr<std::complex<MagnitudeType>,MV,OP>
136 {
137  public:
138 
139  typedef std::complex<MagnitudeType> ScalarType;
141  const RCP<Eigenproblem<ScalarType,MV,OP> > &problem,
143  {
144  // Provide a compile error when attempting to instantiate on complex type
145  MagnitudeType::this_class_is_missing_a_specialization();
146  }
147 };
148 
150 // Constructor - accepts maximum iterations in addition to the other parameters of the abstract base class
151 template<class ScalarType, class MV, class OP>
153  TraceMinBaseSolMgr<ScalarType,MV,OP>(problem,pl)
154 {
155  // Get the maximum number of iterations
156  maxits_ = pl.get("Maximum Iterations", 100);
157  TEUCHOS_TEST_FOR_EXCEPTION(maxits_ < 1, std::invalid_argument, "Anasazi::TraceMinSolMgr::constructor(): \"Maximum Iterations\" must be strictly positive.");
158 
159  // block size: default is 2* nev()
160  // TODO: Find out minimum value
161  this->blockSize_ = pl.get("Block Size",2*this->problem_->getNEV());
162  TEUCHOS_TEST_FOR_EXCEPTION(this->blockSize_ < this->problem_->getNEV(), std::invalid_argument,
163  "Anasazi::TraceMinSolMgr::constructor(): \"Block Size\" must be greater than or equal to the number of desired eigenpairs.");
164 
165  this->useHarmonic_ = pl.get("Use Harmonic Ritz Values", false);
166  TEUCHOS_TEST_FOR_EXCEPTION(this->useHarmonic_, std::invalid_argument,
167  "Anasazi::TraceMinSolMgr::constructor(): Please disable the harmonic Ritz values. It doesn't make sense to use them with TraceMin, which does not use expanding subspaces. Perhaps you wanted TraceMin-Davidson?");
168 
169  // TraceMin does not restart, so the number of blocks and number of restart blocks will always be 1
170  this->numBlocks_ = 1;
171  this->numRestartBlocks_ = 1;
172 
173  TEUCHOS_TEST_FOR_EXCEPTION(static_cast<ptrdiff_t>(this->numBlocks_)*this->blockSize_ + this->maxLocked_ > MVT::GetGlobalLength(*this->problem_->getInitVec()),
174  std::invalid_argument,
175  "Anasazi::TraceMinSolMgr::constructor(): Potentially impossible orthogonality requests. Reduce basis size or locking size.");
176 
177  TEUCHOS_TEST_FOR_EXCEPTION(this->maxLocked_ + this->blockSize_ < this->problem_->getNEV(), std::invalid_argument,
178  "Anasazi::TraceMinDavidsonSolMgr: Not enough storage space for requested number of eigenpairs.");
179 }
180 
181 
183 // Returns a new TraceMin solver object
184 template <class ScalarType, class MV, class OP>
187  const Teuchos::RCP<StatusTest<ScalarType,MV,OP> > &outputtest,
190  )
191 {
192  return Teuchos::rcp( new TraceMin<ScalarType,MV,OP>(this->problem_,sorter,this->printer_,outputtest,ortho,plist) );
193 }
194 
195 
196 }} // end Anasazi namespace
197 
198 #endif /* ANASAZI_TRACEMIN_SOLMGR_HPP */
static ptrdiff_t GetGlobalLength(const MV &mv)
Return the number of rows in the given multivector mv.
This class implements a TraceMIN iteration, a preconditioned iteration for solving linear symmetric p...
This class defines the interface required by an eigensolver and status test class to compute solution...
T & get(const std::string &name, T def_value)
#define TEUCHOS_TEST_FOR_EXCEPTION(throw_exception_test, Exception, msg)
Virtual base class which defines basic traits for the operator type.
Basic implementation of the Anasazi::SortManager class.
The Anasazi::TraceMinBaseSolMgr provides an abstract base class for the TraceMin series of solver man...
A status test for testing the norm of the eigenvectors residuals along with a set of auxiliary eigenv...
Anasazi&#39;s templated virtual class for providing routines for orthogonalization and orthonormalization...
TraceMinSolMgr(const Teuchos::RCP< Eigenproblem< ScalarType, MV, OP > > &problem, Teuchos::ParameterList &pl)
Basic constructor for TraceMinSolMgr.
Abstract class definition for Anasazi Output Managers.
TEUCHOS_DEPRECATED RCP< T > rcp(T *p, Dealloc_T dealloc, bool owns_mem)
Abstract base class which defines the interface required by an eigensolver and status test class to c...
A status test for testing the norm of the eigenvectors residuals.
Traits class which defines basic operations on multivectors.
Anasazi header file which uses auto-configuration information to include necessary C++ headers...
The Anasazi::TraceMinBaseSolMgr provides an abstract base class for the TraceMin series of solver man...
The Anasazi::TraceMinSolMgr provides a flexible solver manager over the TraceMin eigensolver.
Special StatusTest for printing status tests.
Status test for forming logical combinations of other status tests.
Types and exceptions used within Anasazi solvers and interfaces.
This is an abstract base class for the trace minimization eigensolvers.
Anasazi&#39;s templated pure virtual class for managing the sorting of approximate eigenvalues computed b...
Common interface of stopping criteria for Anasazi&#39;s solvers.
Implementation of the trace minimization eigensolver.
Class which provides internal utilities for the Anasazi solvers.