Amesos2 - Direct Sparse Solver Interfaces
Version of the Day
|
Amesos2 interface to the Multi-threaded version of SuperLU. More...
#include <Amesos2_Superlumt_decl.hpp>
Public Types | |
typedef Superlumt< Matrix, Vector > | type |
typedef SolverCore < Amesos2::Superlumt, Matrix, Vector > | super_type |
typedef super_type::scalar_type | scalar_type |
typedef super_type::local_ordinal_type | local_ordinal_type |
typedef super_type::global_ordinal_type | global_ordinal_type |
typedef super_type::global_size_type | global_size_type |
typedef TypeMap < Amesos2::Superlumt, scalar_type > | type_map |
typedef type_map::type | slu_type |
typedef type_map::magnitude_type | magnitude_type |
typedef FunctionMap < Amesos2::Superlumt, slu_type > | function_map |
typedef ConcreteSolver< Matrix, Vector > | solver_type |
typedef Matrix | matrix_type |
typedef Vector | vector_type |
typedef MatrixAdapter < matrix_type >::node_t | node_type |
Public Member Functions | |
bool | matrixShapeOK () |
Returns true if the solver can handle this matrix shape. More... | |
void | setA (const Teuchos::RCP< const Matrix > a, EPhase keep_phase=CLEAN) |
Sets the matrix A of this solver. More... | |
void | setA (const Matrix *a, EPhase keep_phase=CLEAN) |
Sets the matrix A of this solver. More... | |
void | setX (const Teuchos::RCP< Vector > x) |
Sets the LHS vector X. | |
void | setX (Vector *x) |
Sets the LHS vector X using a raw pointer. | |
const Teuchos::RCP< Vector > | getX () |
Returns the vector that is the LHS of the linear system. | |
Vector * | getXRaw () |
Returns a raw pointer to the LHS of the linear system. | |
void | setB (const Teuchos::RCP< const Vector > b) |
Sets the RHS vector B. | |
void | setB (const Vector *b) |
Sets the RHS vector B using a raw pointer. | |
const Teuchos::RCP< const Vector > | getB () |
Returns the vector that is the RHS of the linear system. | |
const Vector * | getBRaw () |
Returns a raw pointer to the RHS of the linear system. | |
std::string | description () const |
Returns a short description of this Solver. | |
void | describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel=Teuchos::Describable::verbLevel_default) const |
void | printTiming (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const |
Prints timing information about the current solver. More... | |
void | getTiming (Teuchos::ParameterList &timingParameterList) const |
Extracts timing information from the current solver. More... | |
std::string | name () const |
Return the name of this solver. More... | |
Constructor/Destructor methods | |
Superlumt (Teuchos::RCP< const Matrix > A, Teuchos::RCP< Vector > X, Teuchos::RCP< const Vector > B) | |
Initialize from Teuchos::RCP. More... | |
~Superlumt () | |
Destructor. | |
Mathematical functions | |
super_type & | preOrdering () |
Pre-orders the matrix A for minimal fill-in. More... | |
super_type & | symbolicFactorization () |
Performs symbolic factorization on the matrix A. More... | |
super_type & | numericFactorization () |
Performs numeric factorization on the matrix A. More... | |
void | solve () |
Solves (or ) More... | |
void | solve (const Teuchos::Ptr< Vector > X, const Teuchos::Ptr< const Vector > B) const |
Solve using the given X and B vectors. More... | |
void | solve (Vector *X, const Vector *B) const |
Solve using the given X and B vectors. More... | |
Parameter methods | |
super_type & | setParameters (const Teuchos::RCP< Teuchos::ParameterList > ¶meterList) |
Set/update internal variables and solver options. More... | |
Teuchos::RCP< const Teuchos::ParameterList > | getValidParameters () const |
Return a const parameter list of all of the valid parameters that this->setParameterList(...) will accept. More... | |
void | setParameterList (const Teuchos::RCP< Teuchos::ParameterList > ¶meterList) |
Set or update internal variables and solver options. More... | |
Teuchos::RCP < Teuchos::ParameterList > | getNonconstParameterList () |
This is a empty stub. More... | |
Teuchos::RCP < Teuchos::ParameterList > | unsetParameterList () |
This is an empty stub. More... | |
Accessor methods | |
Teuchos::RCP< const Teuchos::Comm< int > > | getComm () const |
Returns a pointer to the Teuchos::Comm communicator with this operator. | |
Status & | getStatus () const |
Returns a reference to this solver's internal status object. | |
Static Public Attributes | |
static const char * | name = "SuperLU_MT" |
Name of this solver interface. | |
Protected Member Functions | |
void | setNnzLU (size_t nnz) |
Set the number of non-zero values in the and factors. More... | |
Protected Attributes | |
Teuchos::RCP< const MatrixAdapter< Matrix > > | matrixA_ |
The LHS operator. | |
bool | matrix_loaded_ |
Teuchos::RCP< Vector > | multiVecX_ |
The LHS vector/multi-vector. | |
Teuchos::RCP< const Vector > | multiVecB_ |
The RHS vector/multi-vector. More... | |
global_size_type | globalNumRows_ |
Number of global rows in matrixA_ . | |
global_size_type | globalNumCols_ |
Number of global columns in matrixA_ . | |
global_size_type | globalNumNonZeros_ |
Number of global non-zero values in matrixA_ . | |
global_size_type | rowIndexBase_ |
Index base of rowmap of matrixA_ . | |
global_size_type | columnIndexBase_ |
Index base of column map of matrixA_ . | |
Status | status_ |
Holds status information about a solver. | |
Control | control_ |
Parameters for solving. | |
Timers | timers_ |
Various timing statistics. | |
int | rank_ |
The MPI rank of this image. | |
bool | root_ |
If true , then this is the root processor. | |
int | nprocs_ |
Number of process images in the matrix communicator. | |
Private Member Functions | |
int | preOrdering_impl () |
Performs pre-ordering on the matrix to increase efficiency. More... | |
int | symbolicFactorization_impl () |
Perform symbolic factorization of the matrix using SuperLU_MT. More... | |
int | numericFactorization_impl () |
SuperLU_MT specific numeric factorization. More... | |
int | solve_impl (const Teuchos::Ptr< MultiVecAdapter< Vector > > X, const Teuchos::Ptr< const MultiVecAdapter< Vector > > B) const |
SuperLU_MT specific solve. More... | |
bool | matrixShapeOK_impl () const |
Determines whether the shape of the matrix is OK for this solver. More... | |
void | setParameters_impl (const Teuchos::RCP< Teuchos::ParameterList > ¶meterList) |
Teuchos::RCP< const Teuchos::ParameterList > | getValidParameters_impl () const |
bool | loadA_impl (EPhase current_phase) |
Reads matrix data into internal structures. More... | |
Private Attributes | |
struct Amesos2::Superlumt::SLUData | data_ |
Teuchos::Array< typename TypeMap< Amesos2::Superlumt, scalar_type >::type > | nzvals_ |
Stores the values of the nonzero entries for SuperLU. | |
Teuchos::Array< int > | rowind_ |
Stores the row indices of the nonzero entries. | |
Teuchos::Array< int > | colptr_ |
Stores the location in Ai_ and Aval_ that starts row j. | |
bool | is_contiguous_ |
Friends | |
class | SolverCore< Amesos2::Superlumt, Matrix, Vector > |
Amesos2 interface to the Multi-threaded version of SuperLU.
The multi-threaded version of SuperLU, SuperLU_MT, is supported by this Amesos2 interface. Currently support is for the SuperLU_MT 2.0 version.
See the summary of SuperLU_MTparameters" supported this Amesos2 interface
Amesos2::Superlumt< Matrix, Vector >::Superlumt | ( | Teuchos::RCP< const Matrix > | A, |
Teuchos::RCP< Vector > | X, | ||
Teuchos::RCP< const Vector > | B | ||
) |
Initialize from Teuchos::RCP.
References Amesos2::SolverCore< ConcreteSolver, Matrix, Vector >::getValidParameters(), Amesos2::SolverCore< ConcreteSolver, Matrix, Vector >::globalNumCols_, Amesos2::SolverCore< ConcreteSolver, Matrix, Vector >::globalNumRows_, and Amesos2::SolverCore< ConcreteSolver, Matrix, Vector >::setParameters().
|
private |
Performs pre-ordering on the matrix to increase efficiency.
SuperLU_MT supports several forms of column permutations. Refer to slu_mt_options for the available ColPerm
options.
|
private |
Perform symbolic factorization of the matrix using SuperLU_MT.
Called second in the sequence before numericFactorization.
std::runtime_error | SuperLU_MT is not able to factor the matrix. |
|
private |
SuperLU_MT specific numeric factorization.
SuperLU_MT factors the matrix in a shared memory environment using nprocs
threads, where nprocs defaults to 1
if it is not changed through setParameters()
.
std::runtime_error | SuperLU_MT is not able to factor the matrix |
|
private |
SuperLU_MT specific solve.
Uses the symbolic and numeric factorizations, along with the RHS vector B
to solve the sparse system of equations. The solution is placed in X.
std::runtime_error | SuperLU_MT is not able to solve the system. |
References Amesos2::Util::scale().
|
private |
Determines whether the shape of the matrix is OK for this solver.
SuperLU_MT supports square matrices.
|
private |
The following SuperLU_MT parameters/options are recognized:
"nprocs"
(int) : Specifies the number of threads to be spawned. Default is 1. "trans"
: { "NOTRANS"
| "TRANS"
| "CONJ"
}. Will also recognize the "Transpose"
: { true
| false
} option which is equivalent to "TRANS"
and "NOTRANS"
, respectively. "panel_size"
(int) : Specifies the number of consecutive columns to be treated as a unit of task. "relax"
(int) : Specifies the number of columns to be grouped as a relaxed supernode. "Equil"
: { true
| false
}. Specifies whether the solver to equilibrate the matrix before solving. "SymmetricMode"
: { true
| false
}. Specifies whether to use the symmetric mode. "DiagPivotThresh"
: double
value. Specifies the threshold used for a diagonal to be considered an acceptable pivot. "ColPerm"
which takes one of the following: "NATURAL"
: natural ordering. "MMD_AT_PLUS_A"
: minimum degree ordering on the structure of . "MMD_ATA"
: minimum degree ordering on the structure of . "COLAMD"
: approximate minimum degree column ordering. (default) Note that the nprocs
, panel_size
, and relax
options are recognized by SuperLU_MT but not by SuperLU. Note also that it is no typo in "trans", it really is lower-case (as opposed to upper-case in SuperLU)
|
private |
Hooked in by Amesos2::SolverCore parent class.
|
private |
Reads matrix data into internal structures.
[in] | current_phase | an indication of which solution phase this load is being performed for. |
true
if the matrix was loaded, false
if not
|
virtualinherited |
Pre-orders the matrix A for minimal fill-in.
Rearranges the rows and columns of the matrix A to minimize the amount of fill-in of the non-zero entries of the matrix. Pre-ordering may or may not be supported by the underlying solver. If not supported, a call to this method simply does nothing.
this
. Implements Amesos2::Solver< Matrix, Vector >.
|
virtualinherited |
Performs symbolic factorization on the matrix A.
In addition to performing symbolic factorization on the matrix A, the call to symbolicFactorization() implies that no change will be made to the non-zero structure of the underlying matrix without a subsequent call to symbolicFactorization().
this
. Implements Amesos2::Solver< Matrix, Vector >.
|
virtualinherited |
Performs numeric factorization on the matrix A.
In addition to performing numeric factorization on the matrix A, the call to numericFactorization() implies that no change will be made to the underlying matrix values without a subsequent call to numericFactorization().
this
Implements Amesos2::Solver< Matrix, Vector >.
|
virtualinherited |
Solves (or )
Implements Amesos2::Solver< Matrix, Vector >.
|
virtualinherited |
Solve using the given X and B vectors.
This overload of solve uses the given X and B vectors when solving. This X and B are used in place of any X and B that were given upon construction of the Amesos2 solver instance and are used only for this solve.
If a permanent change of X and B are required, see the setX() and setB() methods.
X
contains the solution to the systemX
and B
given at construction time (if any) are unchanged. Implements Amesos2::Solver< Matrix, Vector >.
|
virtualinherited |
Solve using the given X and B vectors.
This overload of solve uses the given X and B vectors when solving. This X and B are used in place of any X and B that were given upon construction of the Amesos2 solver instance and are used only for this solve.
If a permanent change of X and B are required, see the setX() and setB() methods.
X
contains the solution to the systemX
and B
given at construction time (if any) are unchanged. Implements Amesos2::Solver< Matrix, Vector >.
|
virtualinherited |
Returns true
if the solver can handle this matrix shape.
Returns true if the matrix shape is one that the underlying concrete sparse direct solver can handle. Classes that work only on square matrices should return false for rectangular matrices. Classes that work only on symmetric matrices would return false for non-symmetric matrices. etc.
Implements Amesos2::Solver< Matrix, Vector >.
Referenced by Amesos2::SolverCore< ConcreteSolver, Matrix, Vector >::SolverCore().
|
virtualinherited |
Sets the matrix A of this solver.
[in] | a | An RCP to a matrix will will be used for future computation steps |
[in] | keep_phase | This parameter tells the solver what state it should keep. For example, you may want to replace the matrix but keep the symbolic factorization because you know the structure of the new matrix is the same as the structure of the old matrix. In this case you would pass Amesos2::SYMBFACT as this parameter. |
The default value for the second parameter is Amesos2::CLEAN, which means that the internal state of the solver will be completely reset. It will be as if no previous computational steps were performed.
Implements Amesos2::Solver< Matrix, Vector >.
|
inlinevirtualinherited |
Sets the matrix A of this solver.
[in] | a | An raw C pointer to a matrix will will be used for future computation steps. |
[in] | keep_phase | This parameter tells the solver what state it should keep. For example, you may want to replace the matrix but keep the symbolic factorization because you know the structure of the new matrix is the same as the structure of the old matrix. In this case you would pass Amesos2::SYMBFACT as this parameter. |
The default value for the second parameter is Amesos2::CLEAN, which means that the internal state of the solver will be completely reset. It will be as if no previous computational steps were performed.
Implements Amesos2::Solver< Matrix, Vector >.
Referenced by Amesos2::SolverCore< Amesos2::Umfpack, Matrix, Vector >::setA().
|
virtualinherited |
Set/update internal variables and solver options.
The setParameters method is consistent over all concrete solvers. It accepts general status and control parameters, as well as parameters specific to a given solver. If the solver does not recognize the parameter, then it will simply be ignored
parameterList
. Parameters not specified in parameterList
revert to their default values.this
Implements Amesos2::Solver< Matrix, Vector >.
Referenced by Amesos2::Lapack< Matrix, Vector >::Lapack(), Amesos2::SolverCore< Amesos2::Umfpack, Matrix, Vector >::setParameterList(), Amesos2::Superludist< Matrix, Vector >::Superludist(), and Amesos2::Superlumt< Matrix, Vector >::Superlumt().
|
virtualinherited |
Return a const parameter list of all of the valid parameters that this->setParameterList(...) will accept.
"YES"
and "NO"
as well as true
and false
). Implements Amesos2::Solver< Matrix, Vector >.
Referenced by Amesos2::Lapack< Matrix, Vector >::Lapack(), Amesos2::Superludist< Matrix, Vector >::Superludist(), and Amesos2::Superlumt< Matrix, Vector >::Superlumt().
|
inlineinherited |
Set or update internal variables and solver options.
Redefined from Teuchos::ParameterListAcceptor
setParameters()
[in] | parameterList |
|
inlineinherited |
This is a empty stub.
|
inlineinherited |
This is an empty stub.
|
virtualinherited |
Prints the status information about the current solver with some level of verbosity
Implements Amesos2::Solver< Matrix, Vector >.
References Amesos2::Util::printLine().
|
virtualinherited |
Prints timing information about the current solver.
The Amesos2::SolverCore
base class takes care of tracking total time spent in the Amesos2 interface. Concrete solver interface class are responsible for reporting other timing statistics, which include time spent in:
Implements Amesos2::Solver< Matrix, Vector >.
References Amesos2::Util::printLine().
|
virtualinherited |
Extracts timing information from the current solver.
Results are placed into the parameter list timingParameterList
.
[out] | timingParameterList | Accepts timing information from the current solver |
Implements Amesos2::Solver< Matrix, Vector >.
|
virtualinherited |
Return the name of this solver.
The name is given by the underlying concrete solver instance
std::string
which is the name of this solver Implements Amesos2::Solver< Matrix, Vector >.
|
inlineprotectedinherited |
Set the number of non-zero values in the and factors.
Concrete solver classes may call this method if they wish to (or are able to) report the number of conbined non-zero count for the and factors.
|
protectedinherited |
If true
indicates that the current matrix A has been loaded into internal solver structures.
|
protectedinherited |
The RHS vector/multi-vector.
We point to a const Vector because Amesos2 should never directly modify B.
Referenced by Amesos2::SolverCore< Amesos2::Umfpack, Matrix, Vector >::getB(), Amesos2::SolverCore< Amesos2::Umfpack, Matrix, Vector >::getBRaw(), and Amesos2::SolverCore< Amesos2::Umfpack, Matrix, Vector >::setB().