Belos Version of the Day
Public Types | Static Public Member Functions
Belos::GmresBaseFactory< Scalar, MV, OP > Class Template Reference

Factory for creating GmresBase subclass instances. More...

#include <BelosGmresBaseFactory.hpp>

List of all members.

Public Types

typedef GmresBase< Scalar, MV, OP > base_type
typedef LinearProblem< Scalar,
MV, OP > 
lp_type
typedef OrthoManager< Scalar, MV > ortho_type

Static Public Member Functions

static Teuchos::RCP< base_typecreate (const Teuchos::RCP< lp_type > &lp, const Teuchos::RCP< const ortho_type > &ortho, const Teuchos::RCP< OutputManager< Scalar > > &outMan, const Teuchos::RCP< const Teuchos::ParameterList > &params)
 Instantiate the appropriate GmresBase subclass instance.

Detailed Description

template<class Scalar, class MV, class OP>
class Belos::GmresBaseFactory< Scalar, MV, OP >

Factory for creating GmresBase subclass instances.

Author:
Mark Hoemmen
Warning:
This is EXPERIMENTAL CODE. DO NOT RELY ON THIS CODE. The interface or implementation may change at any time.

GmresBase describes a general GMRES or Flexible GMRES (FGMRES) iteration, and leaves the specifics up to the subclasses. GmresBaseFactory is a factory class that generates subclass instances. The factory is responsible for:

Definition at line 75 of file BelosGmresBaseFactory.hpp.


Member Typedef Documentation

template<class Scalar , class MV , class OP >
typedef GmresBase<Scalar, MV, OP> Belos::GmresBaseFactory< Scalar, MV, OP >::base_type

Definition at line 77 of file BelosGmresBaseFactory.hpp.

template<class Scalar , class MV , class OP >
typedef LinearProblem<Scalar, MV, OP> Belos::GmresBaseFactory< Scalar, MV, OP >::lp_type

Definition at line 78 of file BelosGmresBaseFactory.hpp.

template<class Scalar , class MV , class OP >
typedef OrthoManager<Scalar, MV> Belos::GmresBaseFactory< Scalar, MV, OP >::ortho_type

Definition at line 79 of file BelosGmresBaseFactory.hpp.


Member Function Documentation

template<class Scalar , class MV , class OP >
static Teuchos::RCP<base_type> Belos::GmresBaseFactory< Scalar, MV, OP >::create ( const Teuchos::RCP< lp_type > &  lp,
const Teuchos::RCP< const ortho_type > &  ortho,
const Teuchos::RCP< OutputManager< Scalar > > &  outMan,
const Teuchos::RCP< const Teuchos::ParameterList > &  params 
) [inline, static]

Instantiate the appropriate GmresBase subclass instance.

Parameters:
lp[in/out] The linear problem to solve.
ortho[in] The orthogonalization method that (F)GMRES should use when solving the linear problem.
params[in] Optional parameters; if null, defaults are used.
Returns:
GmresBase subclass instance for solving the linear system.

Definition at line 92 of file BelosGmresBaseFactory.hpp.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines