Amesos Class Reference

Factory for binding a third party direct solver to an Epetra_LinearProblem. More...

#include <Amesos.h>

List of all members.

Public Member Functions

Creation method for char*
Amesos_BaseSolverCreate (const char *ClassType, const Epetra_LinearProblem &LinearProblem)
 Amesos Create method.
Amesos_BaseSolverCreate (const std::string CT, const Epetra_LinearProblem &LinearProblem)
 Creation method for string input.

Query methods

bool Query (const char *ClassType)
 Queries whether a given interface is avaiable or not.
bool Query (const std::string CT)
 Queries whether a given interface is avaiable or not.
static Teuchos::ParameterList GetValidParameters ()
 Get the list of valid parameters.


Detailed Description

Factory for binding a third party direct solver to an Epetra_LinearProblem.

Amesos creates an instance of a solver, binding a third party direct solver to an Epetra_LinearProblem, allowing access to the specified third party solver through the Amesos interface (i.e. Numeric Factorization SymbolicFactrozation(), Solve() and support functions.)


Member Function Documentation

Amesos_BaseSolver* Amesos::Create ( const std::string  CT,
const Epetra_LinearProblem &  LinearProblem 
)

Creation method for string input.

Amesos_BaseSolver* Amesos::Create ( const char *  ClassType,
const Epetra_LinearProblem &  LinearProblem 
)

Amesos Create method.

Creates an instance of the Amesos_BaseSolver class specified by ClassType.

<br >Preconditions:

  • ClassType must be one of the recognized class types. Return 0 on failure.
  • ClassType must specify a third party solver that has been linked with this particular implementation. Return 0 on failure.
  • Epetra_LinearProblem may be empty. Although the linear problem is not checked at the time of construction, the operator must be an Epetra_RowMatrix, or derived from an Epetra_RowMatrix.

<br >Postconditions:

  • If Create() returns a non-null pointer, that pointer points to an Amesos solver.

static Teuchos::ParameterList Amesos::GetValidParameters (  )  [static]

Get the list of valid parameters.

bool Amesos::Query ( const std::string  CT  ) 

Queries whether a given interface is avaiable or not.

bool Amesos::Query ( const char *  ClassType  ) 

Queries whether a given interface is avaiable or not.


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