Anasazi  Version of the Day
AnasaziSolverManager.hpp
Go to the documentation of this file.
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Anasazi: Block Eigensolvers Package
5 // Copyright 2004 Sandia Corporation
6 //
7 // Under terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
8 // the U.S. Government retains certain rights in this software.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
38 //
39 // ***********************************************************************
40 // @HEADER
41 
42 #ifndef ANASAZI_SOLVERMANAGER_HPP
43 #define ANASAZI_SOLVERMANAGER_HPP
44 
49 #include "AnasaziConfigDefs.hpp"
50 #include "AnasaziTypes.hpp"
51 #include "AnasaziEigenproblem.hpp"
52 
53 #include "Teuchos_ParameterList.hpp"
54 #include "Teuchos_RCP.hpp"
55 #include "Teuchos_Array.hpp"
56 #include "Teuchos_Time.hpp"
57 
63 namespace Anasazi {
64 
65 template<class ScalarType, class MV, class OP>
67 
68  public:
69 
71 
72 
75 
77  virtual ~SolverManager() {};
79 
81 
82 
84  virtual const Eigenproblem<ScalarType,MV,OP>& getProblem() const = 0;
85 
87  virtual int getNumIters() const = 0;
88 
90  virtual Teuchos::Array<Teuchos::RCP<Teuchos::Time> > getTimers() const
91  {
92  Teuchos::Array<Teuchos::RCP<Teuchos::Time> > null_time;
93  return null_time;
94  }
95 
97 
99 
100 
109  virtual ReturnType solve() = 0;
111 
112 };
113 
114 } // end Anasazi namespace
115 
116 #endif /* ANASAZI_SOLVERMANAGER_HPP */
AnasaziTypes.hpp
Types and exceptions used within Anasazi solvers and interfaces.
Anasazi::SolverManager
The Anasazi::SolverManager is a templated virtual base class that defines the basic interface that an...
Definition: AnasaziSolverManager.hpp:66
AnasaziEigenproblem.hpp
Abstract base class which defines the interface required by an eigensolver and status test class to c...
Anasazi::SolverManager::SolverManager
SolverManager()
Empty constructor.
Definition: AnasaziSolverManager.hpp:74
Anasazi::SolverManager::~SolverManager
virtual ~SolverManager()
Destructor.
Definition: AnasaziSolverManager.hpp:77
Anasazi::SolverManager::getTimers
virtual Teuchos::Array< Teuchos::RCP< Teuchos::Time > > getTimers() const
Return the timers for this object.
Definition: AnasaziSolverManager.hpp:90
Anasazi::ReturnType
ReturnType
Enumerated type used to pass back information from a solver manager.
Definition: AnasaziTypes.hpp:120
Anasazi::SolverManager::getProblem
virtual const Eigenproblem< ScalarType, MV, OP > & getProblem() const =0
Return the eigenvalue problem.
Anasazi::SolverManager::solve
virtual ReturnType solve()=0
This method performs possibly repeated calls to the underlying eigensolver's iterate() routine until ...
Anasazi
Namespace Anasazi contains the classes, structs, enums and utilities used by the Anasazi package.
Anasazi::Eigenproblem
This class defines the interface required by an eigensolver and status test class to compute solution...
Definition: AnasaziEigenproblem.hpp:64
AnasaziConfigDefs.hpp
Anasazi header file which uses auto-configuration information to include necessary C++ headers.
Anasazi::SolverManager::getNumIters
virtual int getNumIters() const =0
Get the iteration count for the most recent call to solve().