Amesos Package Browser (Single Doxygen Collection)  Development
List of all members
Amesos Class Reference

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

#include <Amesos.h>

Creation method for char*

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

Query methods

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

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.)

Definition at line 44 of file Amesos.h.

Member Function Documentation

◆ Create() [1/2]

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.

Definition at line 69 of file Amesos.cpp.

◆ Create() [2/2]

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

Creation method for string input.

Definition at line 76 of file Amesos.cpp.

◆ Query() [1/2]

bool Amesos::Query ( const char *  ClassType)

Queries whether a given interface is available or not.

Definition at line 193 of file Amesos.cpp.

◆ Query() [2/2]

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

Queries whether a given interface is available or not.

Definition at line 200 of file Amesos.cpp.

◆ GetValidParameters()

Teuchos::ParameterList Amesos::GetValidParameters ( )
static

Get the list of valid parameters.

Definition at line 303 of file Amesos.cpp.


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