Belos Package Browser (Single Doxygen Collection)  Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
BelosCustomSolverFactory.hpp
Go to the documentation of this file.
1 //@HEADER
2 // ************************************************************************
3 //
4 // Belos: Block Linear Solvers Package
5 // Copyright 2004 Sandia Corporation
6 //
7 // Under the 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 BELOSSOLVERFACTORYBASE_HPP
43 #define BELOSSOLVERFACTORYBASE_HPP
44 
45 #include <string>
46 #include <vector>
47 #include "Teuchos_RCP.hpp"
48 
49 #ifndef DOXYGEN_SHOULD_SKIP_THIS
50 namespace Teuchos {
51 // Forward declaration
52 class ParameterList;
53 } // namespace Teuchos
54 #endif // DOXYGEN_SHOULD_SKIP_THIS
55 
56 namespace Belos {
57 
58 #ifndef DOXYGEN_SHOULD_SKIP_THIS
59 // Forward declaration
60 template<class Scalar, class MV, class OP>
61 class SolverManager;
62 #endif // DOXYGEN_SHOULD_SKIP_THIS
63 
80 template<class Scalar, class MV, class OP>
82 public:
114  getSolver (const std::string& solverName,
115  const Teuchos::RCP<Teuchos::ParameterList>& solverParams) = 0;
116 
122  virtual int numSupportedSolvers () const = 0;
123 
129  virtual std::vector<std::string> supportedSolverNames () const = 0;
130 
132  virtual bool isSupported (const std::string& solverName) const = 0;
133 
135  virtual ~CustomSolverFactory () {}
136 };
137 
138 } // namespace Belos
139 
140 #endif // BELOSSOLVERFACTORYBASE_HPP
virtual int numSupportedSolvers() const =0
Number of supported solvers.
Interface for custom Belos solver factories.
virtual Teuchos::RCP< SolverManager< Scalar, MV, OP > > getSolver(const std::string &solverName, const Teuchos::RCP< Teuchos::ParameterList > &solverParams)=0
Return an instance of the specified solver, or Teuchos::null if this factory does not provide the req...
virtual ~CustomSolverFactory()
Destructor (virtual, for safety of derived classes).
virtual bool isSupported(const std::string &solverName) const =0
Whether the given solver name names a supported solver.
virtual std::vector< std::string > supportedSolverNames() const =0
List of supported solver names.