NeoN::la::LinearSystem< ValueType, IndexType > Class Template Reference

A class representing a linear system of equations. More...

#include <linearSystem.hpp>

Public Member Functions
	LinearSystem (const CSRMatrix< ValueType, IndexType > &matrix, const Vector< ValueType > &rhs, const Dictionary &aux={})
	LinearSystem (const LinearSystem &ls)
	LinearSystem (const Executor exec)
	~LinearSystem ()=default
CSRMatrix< ValueType, IndexType > &	matrix ()
Vector< ValueType > &	rhs ()
const CSRMatrix< ValueType, IndexType > &	matrix () const
const Vector< ValueType > &	rhs () const
LinearSystem	copyToHost () const
void	reset ()
LinearSystemView< ValueType, IndexType >	view () &&=delete
LinearSystemView< ValueType, IndexType >	view () const &&=delete
LinearSystemView< ValueType, IndexType >	view () &
LinearSystemView< const ValueType, const IndexType >	view () const &
const Executor &	exec () const
const Dictionary &	auxiliaryCoefficients () const
Dictionary &	auxiliaryCoefficients ()

Detailed Description

template<typename ValueType, typename IndexType>
class NeoN::la::LinearSystem< ValueType, IndexType >

A class representing a linear system of equations.

The LinearSystem class provides functionality to store and manipulate a linear system of equations. It supports the storage of the coefficient matrix and the right-hand side vector, as well as the solution vector.

Definition at line 56 of file linearSystem.hpp.

Constructor & Destructor Documentation

LinearSystem() [1/3]

template<typename ValueType , typename IndexType >

NeoN::la::LinearSystem< ValueType, IndexType >::LinearSystem ( const CSRMatrix< ValueType, IndexType > &  matrix, const Vector< ValueType > &  rhs, const Dictionary &  aux = {}  )

inline

Definition at line 60 of file linearSystem.hpp.

LinearSystem() [2/3]

template<typename ValueType , typename IndexType >

NeoN::la::LinearSystem< ValueType, IndexType >::LinearSystem ( const LinearSystem< ValueType, IndexType > &  ls )

inline

Definition at line 71 of file linearSystem.hpp.

LinearSystem() [3/3]

template<typename ValueType , typename IndexType >

NeoN::la::LinearSystem< ValueType, IndexType >::LinearSystem ( const Executor  exec )

inline

Definition at line 74 of file linearSystem.hpp.

~LinearSystem()

template<typename ValueType , typename IndexType >

NeoN::la::LinearSystem< ValueType, IndexType >::~LinearSystem ( )

default

Member Function Documentation

auxiliaryCoefficients() [1/2]

template<typename ValueType , typename IndexType >

Dictionary & NeoN::la::LinearSystem< ValueType, IndexType >::auxiliaryCoefficients ( )

inline

Definition at line 116 of file linearSystem.hpp.

auxiliaryCoefficients() [2/2]

template<typename ValueType , typename IndexType >

const Dictionary & NeoN::la::LinearSystem< ValueType, IndexType >::auxiliaryCoefficients ( ) const

inline

Definition at line 114 of file linearSystem.hpp.

copyToHost()

template<typename ValueType , typename IndexType >

LinearSystem NeoN::la::LinearSystem< ValueType, IndexType >::copyToHost ( ) const

inline

Definition at line 86 of file linearSystem.hpp.

exec()

template<typename ValueType , typename IndexType >

const Executor & NeoN::la::LinearSystem< ValueType, IndexType >::exec ( ) const

inline

Definition at line 111 of file linearSystem.hpp.

matrix() [1/2]

template<typename ValueType , typename IndexType >

CSRMatrix< ValueType, IndexType > & NeoN::la::LinearSystem< ValueType, IndexType >::matrix ( )

inline

Definition at line 78 of file linearSystem.hpp.

matrix() [2/2]

template<typename ValueType , typename IndexType >

const CSRMatrix< ValueType, IndexType > & NeoN::la::LinearSystem< ValueType, IndexType >::matrix ( ) const

inline

Definition at line 82 of file linearSystem.hpp.

reset()

template<typename ValueType , typename IndexType >

void NeoN::la::LinearSystem< ValueType, IndexType >::reset ( )

inline

Definition at line 91 of file linearSystem.hpp.

rhs() [1/2]

template<typename ValueType , typename IndexType >

Vector< ValueType > & NeoN::la::LinearSystem< ValueType, IndexType >::rhs ( )

inline

Definition at line 80 of file linearSystem.hpp.

rhs() [2/2]

template<typename ValueType , typename IndexType >

const Vector< ValueType > & NeoN::la::LinearSystem< ValueType, IndexType >::rhs ( ) const

inline

Definition at line 84 of file linearSystem.hpp.

view() [1/4]

template<typename ValueType , typename IndexType >

LinearSystemView< ValueType, IndexType > NeoN::la::LinearSystem< ValueType, IndexType >::view ( ) &

inline

Definition at line 101 of file linearSystem.hpp.

view() [2/4]

template<typename ValueType , typename IndexType >

LinearSystemView< ValueType, IndexType > NeoN::la::LinearSystem< ValueType, IndexType >::view ( ) &&

delete

view() [3/4]

template<typename ValueType , typename IndexType >

LinearSystemView< const ValueType, const IndexType > NeoN::la::LinearSystem< ValueType, IndexType >::view ( ) const &

inline

Definition at line 106 of file linearSystem.hpp.

view() [4/4]

template<typename ValueType , typename IndexType >

LinearSystemView< ValueType, IndexType > NeoN::la::LinearSystem< ValueType, IndexType >::view ( ) const &&

delete

---

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

• /home/runner/work/NeoN/NeoN/include/NeoN/linearAlgebra/linearSystem.hpp