CppNoddy::DenseLinearSystem< _Type > Class Template Reference

A linear system class for vector right-hand sides. More...

#include <DenseLinearSystem.h>

Public Member Functions
	DenseLinearSystem (DenseMatrix< _Type > *m_pA, DenseVector< _Type > *m_pB, std::string which="native")
	Constructor for a dense linear system object. More...
	~DenseLinearSystem ()
	Destructor for a linear system object. More...
void	solve ()
	Solve the sparse system. More...
int	get_det_sign () const
	Get the sign of the determinant of the LHS matrix from the linear system just computed. More...
void	set_monitor_det (bool flag)
	Store the sign of the determinant of the LHS matrix every time a solve is requested on a real system. More...

Protected Types
typedef DenseMatrix< _Type >::row_iter	row_iter
typedef DenseMatrix< _Type >::row_riter	row_riter
typedef DenseMatrix< _Type >::row_citer	row_citer
typedef DenseMatrix< _Type >::elt_iter	elt_iter
typedef DenseMatrix< _Type >::elt_riter	elt_riter
typedef DenseMatrix< _Type >::elt_citer	elt_citer

Detailed Description

template<typename _Type>
class CppNoddy::DenseLinearSystem< _Type >

A linear system class for vector right-hand sides.

The class is constructed for dense typed problems of the form

.

Definition at line 16 of file DenseLinearSystem.h.

Member Typedef Documentation

elt_citer

template<typename _Type >

typedef DenseMatrix<_Type>::elt_citer CppNoddy::DenseLinearSystem< _Type >::elt_citer

protected

Definition at line 26 of file DenseLinearSystem.h.

elt_iter

template<typename _Type >

typedef DenseMatrix<_Type>::elt_iter CppNoddy::DenseLinearSystem< _Type >::elt_iter

protected

Definition at line 24 of file DenseLinearSystem.h.

elt_riter

template<typename _Type >

typedef DenseMatrix<_Type>::elt_riter CppNoddy::DenseLinearSystem< _Type >::elt_riter

protected

Definition at line 25 of file DenseLinearSystem.h.

row_citer

template<typename _Type >

typedef DenseMatrix<_Type>::row_citer CppNoddy::DenseLinearSystem< _Type >::row_citer

protected

Definition at line 22 of file DenseLinearSystem.h.

row_iter

template<typename _Type >

typedef DenseMatrix<_Type>::row_iter CppNoddy::DenseLinearSystem< _Type >::row_iter

protected

Definition at line 20 of file DenseLinearSystem.h.

row_riter

template<typename _Type >

typedef DenseMatrix<_Type>::row_riter CppNoddy::DenseLinearSystem< _Type >::row_riter

protected

Definition at line 21 of file DenseLinearSystem.h.

Constructor & Destructor Documentation

DenseLinearSystem()

template<typename _Type >

CppNoddy::DenseLinearSystem< _Type >::DenseLinearSystem	(	DenseMatrix< _Type > *	m_pA,
		DenseVector< _Type > *	m_pB,
		std::string	which = "native"
	)

Constructor for a dense linear system object.

Parameters

m_pA	A pointer to the 'A matrix', an nxn double/complex dense matrix
m_pB	A pointer to the 'B vector' a size n double/complex dense vector
which	A string that indicates which solver to use

Definition at line 15 of file DenseLinearSystem.cpp.

                                                               :
    m_minPivot(1.e-12), m_detSign(0), m_monitorDet(false) {
    this -> m_pA = p_A;
    this -> m_pB = p_B;
    m_version = which;
    if((m_version != "lapack") && (m_version != "native")) {
      std::string problem;
      problem = "The DenseLinearSystem has been instantiated with an unrecognised\n";
      problem += "request for a solver type. Options are 'native' or 'lapack'. \n";
      throw ExceptionRuntime(problem);
    }
  }

~DenseLinearSystem()

template<typename _Type >

CppNoddy::DenseLinearSystem< _Type >::~DenseLinearSystem ( )

inline

Destructor for a linear system object.

Definition at line 37 of file DenseLinearSystem.h.

    {}

Member Function Documentation

get_det_sign()

template<typename _Type >

int CppNoddy::DenseLinearSystem< _Type >::get_det_sign

Get the sign of the determinant of the LHS matrix from the linear system just computed.

Returns

The sign of the determinant of the LAST solved system.

Definition at line 241 of file DenseLinearSystem.cpp.

                                                   {
    return m_detSign;
  }

Referenced by CppNoddy::Newton< _Type >::arclength_solve(), and CppNoddy::Newton< _Type >::iterate().

set_monitor_det()

template<typename _Type >

void CppNoddy::DenseLinearSystem< _Type >::set_monitor_det

(

bool

flag

)

Store the sign of the determinant of the LHS matrix every time a solve is requested on a real system.

Parameters

flag	The boolean value to set.

Definition at line 246 of file DenseLinearSystem.cpp.

                                                          {
    m_monitorDet = flag;
  }

Referenced by CppNoddy::Newton< _Type >::arclength_solve(), and CppNoddy::Newton< _Type >::iterate().

solve()

template<typename _Type >

void CppNoddy::DenseLinearSystem< _Type >::solve

Solve the sparse system.

Definition at line 31 of file DenseLinearSystem.cpp.

                                       {
    if("lapack" == m_version) {
      solve_lapack();
    } else { // we catch incorrect m_version choices in the ctor
      solve_native();
    }
  }

Referenced by CppNoddy::Newton< _Type >::arclength_solve(), CppNoddy::Newton< _Type >::iterate(), and main().

---

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

• include/DenseLinearSystem.h
• src/DenseLinearSystem.cpp