Belos  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Static Public Member Functions | List of all members
Belos::Details::LinearSolverFactory< MV, OP, ScalarType, NormType > Class Template Reference

#include <Belos_Details_LinearSolverFactory.hpp>

Inheritance diagram for Belos::Details::LinearSolverFactory< MV, OP, ScalarType, NormType >:
Inheritance graph
[legend]

Public Member Functions

virtual Teuchos::RCP
< Trilinos::Details::LinearSolver
< MV, OP, NormType > > 
getLinearSolver (const std::string &solverName)
 Get an instance of a Belos solver. More...
 

Static Public Member Functions

static void registerLinearSolverFactory ()
 Register this LinearSolverFactory with the central registry. More...
 

Detailed Description

template<class MV, class OP, class ScalarType, class NormType>
class Belos::Details::LinearSolverFactory< MV, OP, ScalarType, NormType >

Definition at line 26 of file Belos_Details_LinearSolverFactory.hpp.

Member Function Documentation

template<class MV , class OP , class ScalarType , class NormType >
virtual Teuchos::RCP<Trilinos::Details::LinearSolver<MV, OP, NormType> > Belos::Details::LinearSolverFactory< MV, OP, ScalarType, NormType >::getLinearSolver ( const std::string &  solverName)
inlinevirtual

Get an instance of a Belos solver.

The solver is wrapped in a Trilinos::Details::LinearSolver interface.

Parameters
solverName[in] The solver's name. Names are case sensitive.
Returns
A pointer to the solver, if the name was valid; else, a null pointer (Teuchos::null).

Implements Trilinos::Details::LinearSolverFactory< MV, OP, NormType >.

Definition at line 40 of file Belos_Details_LinearSolverFactory.hpp.

template<class MV , class OP , class ScalarType , class NormType >
static void Belos::Details::LinearSolverFactory< MV, OP, ScalarType, NormType >::registerLinearSolverFactory ( )
inlinestatic

Register this LinearSolverFactory with the central registry.

Register this LinearSolverFactory with the central registry, for the given SC, LO, GO, NT template parameters. This will let any clients of Trilinos::Details::getLinearSolver create Belos solvers with those template parameters.

You may call this function multiple times; it will only have an effect the first time (it is idempotent).

Users do not normally have to call this function. Belos automatically registers its LinearSolverFactory with the central repository, for all enabled template parameter combinations.

Definition at line 59 of file Belos_Details_LinearSolverFactory.hpp.


The documentation for this class was generated from the following file:

Generated on Mon Jul 15 2024 09:24:25 for Belos by doxygen 1.8.5