Belos  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Belos_Details_EBelosSolverType.hpp
Go to the documentation of this file.
1 // @HEADER
2 // *****************************************************************************
3 // Belos: Block Linear Solvers Package
4 //
5 // Copyright 2004-2016 NTESS and the Belos contributors.
6 // SPDX-License-Identifier: BSD-3-Clause
7 // *****************************************************************************
8 // @HEADER
9 
10 #ifndef BELOS_DETAILS_EBELOSSOLVERTYPE_HPP
11 #define BELOS_DETAILS_EBELOSSOLVERTYPE_HPP
12 
15 
16 #include <string>
17 #include <utility>
18 #include <vector>
19 
20 #ifndef DOXYGEN_SHOULD_SKIP_THIS
21 namespace Teuchos {
22  // forward declaration (avoid unnecessary include)
23  class ParameterList;
24 } // namespace Teuchos
25 #endif // NOT DOXYGEN_SHOULD_SKIP_THIS
26 
27 namespace Belos {
28 namespace Details {
29 
36 int numSupportedSolvers ();
37 
57 std::pair<std::string, bool>
58 getCanonicalNameFromAlias (const std::string& candidateAlias);
59 
63 std::vector<std::string>
65 
69 std::vector<std::string>
71 
78 void
79 reviseParameterListForAlias (const std::string& aliasName,
80  Teuchos::ParameterList& solverParams);
81 
82 } // namespace Details
83 } // namespace Belos
84 
85 #endif // BELOS_DETAILS_EBELOSSOLVERTYPE_HPP
std::vector< std::string > solverNameAliases()
List of supported aliases (to canonical solver names).
int numSupportedSolvers()
Number of Belos solvers supported for any linear algebra implementation (&quot;generically&quot;).
std::pair< std::string, bool > getCanonicalNameFromAlias(const std::string &candidateAlias)
Get the candidate canonical name for a given candidate alias.
void reviseParameterListForAlias(const std::string &aliasName, Teuchos::ParameterList &solverParams)
Modify the input ParameterList appropriately for the given solver alias.
std::vector< std::string > canonicalSolverNames()
List of canonical solver names.

Generated on Tue Jul 23 2024 09:24:21 for Belos by doxygen 1.8.5