A simple linear solver for use by NOX::LAPACK::Group. More...

#include <NOX_LAPACK_LinearSolver.H>

Inheritance diagram for NOX::LAPACK::LinearSolver< T >:

Public Member Functions
	LinearSolver (int n)
	Constructor.
	LinearSolver (const LinearSolver< T > &s)
	Copy constructor.
	~LinearSolver ()
	Destructor.
LinearSolver &	operator= (const LinearSolver< T > &s)
	Assignment.
Matrix< T > &	getMatrix ()
	Return matrix.
const Matrix< T > &	getMatrix () const
	Return matrix.
void	reset ()
	Reset.
void	apply (bool trans, int ncols, const T input, T output) const
	Apply matrix.
bool	solve (bool trans, int ncols, T *output)
	Solve inverse.

Protected Types
typedef Teuchos::ScalarTraits< T >::magnitudeType	MT

Protected Attributes
Matrix< T >	mat
	Matrix.
Matrix< T >	lu
	LU factorization of matrix.
std::vector< int >	pivots
	Pivots.
bool	isValidLU
	Is LU factorization valid.
Teuchos::BLAS< int, T >	blas
	BLAS wrappers.
Teuchos::LAPACK< int, T >	lapack
	LAPACK wrappers.
int	lwork
	Work array size for GELSS if linear solve fails.
int	rank
	Rank param for GELSS if linear solve fails.
Teuchos::ArrayRCP< MT >	sv
	Singular values for GELSS if linear solve fails.
Teuchos::ArrayRCP< T >	work
	Work array for GELSS if linear solve fails.
Teuchos::ArrayRCP< MT >	rwork
	Magnitude work array for complex-valued GELSS.

Detailed Description

template<typename T>
class NOX::LAPACK::LinearSolver< T >

A simple linear solver for use by NOX::LAPACK::Group.

This class provides a simple linear solver class that stores a NOX::LAPACK::Matrix and provides routines to apply the matrix and solve it using BLAS and LAPACK routines. It is templated so that it can be used to solve both real and complex matrices. It also stores an LU factorization of the matrix so repeated solves are more efficient. The group should signal that the matrix has changed by calling reset().

Constructor & Destructor Documentation

◆ LinearSolver() [1/2]

template<typename T>

NOX::LAPACK::LinearSolver< T >::LinearSolver ( int n )

Constructor.

References blas, isValidLU, lapack, lu, lwork, mat, pivots, sv, and work.

◆ LinearSolver() [2/2]

template<typename T>

NOX::LAPACK::LinearSolver< T >::LinearSolver ( const LinearSolver< T > & s )

Copy constructor.

References blas, isValidLU, lapack, lu, lwork, mat, pivots, sv, and work.

Member Function Documentation

◆ apply()

template<typename T>

void NOX::LAPACK::LinearSolver< T >::apply	(	bool	trans,
		int	ncols,
		const T *	input,
		T *	output ) const

Apply matrix.

Set trans to true to apply the transpose. ncols is the number of columns in input and output, which should be stored column-wise.

References blas, mat, and NOX::LAPACK::Matrix< T >::numRows().

◆ getMatrix() [1/2]

template<typename T>

NOX::LAPACK::Matrix< T > & NOX::LAPACK::LinearSolver< T >::getMatrix ( )

Return matrix.

References mat.

Referenced by LOCA::LAPACK::Group::getJacobianMatrix(), LOCA::LAPACK::Group::getJacobianMatrix(), LOCA::LAPACK::Group::getShiftedMatrix(), and LOCA::LAPACK::Group::getShiftedMatrix().

◆ getMatrix() [2/2]

template<typename T>

const NOX::LAPACK::Matrix< T > & NOX::LAPACK::LinearSolver< T >::getMatrix ( ) const

Return matrix.

References mat.

◆ operator=()

template<typename T>

NOX::LAPACK::LinearSolver< T > & NOX::LAPACK::LinearSolver< T >::operator= ( const LinearSolver< T > & s )

Assignment.

References isValidLU, lu, lwork, mat, pivots, sv, and work.

◆ reset()

template<typename T>

void NOX::LAPACK::LinearSolver< T >::reset ( )

Reset.

Resets the LU factorization indicating the matrix is updated.

References isValidLU.

◆ solve()

template<typename T>

bool NOX::LAPACK::LinearSolver< T >::solve	(	bool	trans,
		int	ncols,
		T *	output )

Solve inverse.

Set trans to true to solve the transpose. ncols is the number of columns in output, which should be stored column- wise. The right-hand-side is passed through output, which is then overwritten with the result.

References isValidLU, lapack, lu, lwork, mat, pivots, rank, rwork, sv, and work.