dg::mat::TridiagInvD< real_type > Class Template Reference

Compute the inverse of a general tridiagonal matrix. More...

Public Types
using	value_type = real_type

Public Member Functions
	TridiagInvD ()
	Allocate nothing, Call construct method before usage.
	TridiagInvD (const thrust::host_vector< real_type > &copyable)
	Construct from vector.
	TridiagInvD (unsigned size)
	Construct from size of vector.
void	resize (unsigned new_size)
	Resize inverse tridiagonal matrix and helper vectors.
void	operator() (const dg::TriDiagonal< thrust::host_vector< real_type > > &T, dg::SquareMatrix< real_type > &Tinv)
	Compute the inverse of a tridiagonal matrix T.
dg::SquareMatrix< real_type >	operator() (const dg::TriDiagonal< thrust::host_vector< real_type > > &T)
	Compute the inverse of a tridiagonal matrix T.
template<class ContainerType0 , class ContainerType1 , class ContainerType2 >
void	operator() (const ContainerType0 &a, const ContainerType1 &b, const ContainerType2 &c, dg::SquareMatrix< real_type > &Tinv)
	Compute the inverse of a tridiagonal matrix with diagonal vectors a,b,c.

Detailed Description

template<class real_type>
class dg::mat::TridiagInvD< real_type >

Compute the inverse of a general tridiagonal matrix.

Attention

If roughly the matrix size m>150 the algorithm is unstable. However, it performs extremely fast if it stays below this value. This is the algorihm of "Inversion of a Tridiagonal Jacobi Matrix" by Riaz A. Usmani

Template Parameters

real_type

float or double

Member Typedef Documentation

value_type

template<class real_type >

using dg::mat::TridiagInvD< real_type >::value_type = real_type

value type of the ContainerType class

Constructor & Destructor Documentation

TridiagInvD() [1/3]

template<class real_type >

dg::mat::TridiagInvD< real_type >::TridiagInvD ( )

inline

Allocate nothing, Call construct method before usage.

TridiagInvD() [2/3]

template<class real_type >

dg::mat::TridiagInvD< real_type >::TridiagInvD ( const thrust::host_vector< real_type > & copyable )

inline

Construct from vector.

Parameters

copyable

vector

TridiagInvD() [3/3]

template<class real_type >

dg::mat::TridiagInvD< real_type >::TridiagInvD ( unsigned size )

inline

Construct from size of vector.

Parameters

size	size of vector

Member Function Documentation

operator()() [1/3]

template<class real_type >

template<class ContainerType0 , class ContainerType1 , class ContainerType2 >

void dg::mat::TridiagInvD< real_type >::operator() ( const ContainerType0 & a, const ContainerType1 & b, const ContainerType2 & c, dg::SquareMatrix< real_type > & Tinv )

inline

Compute the inverse of a tridiagonal matrix with diagonal vectors a,b,c.

The diagonal vectors are given as in the dg::TriDiagonal matrix format

Parameters

a	"0" diagonal vector (index 0 is on row 0, O in dg::TriDiagonal)
b	"+1" diagonal vector (index 0 is on row 0, last index outside, P in dg::TriDiagonal)
c	"-1" diagonal vector (index 0 is on row 0, outside of matrix, M in dg::TriDiagonal)
Tinv	the inverse of the tridiagonal matrix (coordinate format) gets resized if necessary

operator()() [2/3]

template<class real_type >

dg::SquareMatrix< real_type > dg::mat::TridiagInvD< real_type >::operator() ( const dg::TriDiagonal< thrust::host_vector< real_type > > & T )

inline

Compute the inverse of a tridiagonal matrix T.

Parameters

T	tridiagonal matrix

Returns

the inverse of the tridiagonal matrix (coordinate format)

operator()() [3/3]

template<class real_type >

void dg::mat::TridiagInvD< real_type >::operator() ( const dg::TriDiagonal< thrust::host_vector< real_type > > & T, dg::SquareMatrix< real_type > & Tinv )

inline

Compute the inverse of a tridiagonal matrix T.

Parameters

T	tridiagonal matrix
Tinv	the inverse of the tridiagonal matrix (coordinate format) gets resized if necessary

resize()

template<class real_type >

void dg::mat::TridiagInvD< real_type >::resize ( unsigned new_size )

inline

Resize inverse tridiagonal matrix and helper vectors.

Parameters

new_size

new size of square matrix

---

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

• tridiaginv.h