NeoN::la::CsrSparsityPattern< IndexType > Class Template Reference

row and column index representation of a mesh More...

#include <csrSparsityPattern.hpp>

Inheritance diagram for NeoN::la::CsrSparsityPattern< IndexType >:

Public Types
using	SparsityIndexType = IndexType

Public Member Functions
	CsrSparsityPattern (const CsrSparsityPattern &sp)
	CsrSparsityPattern (Vector< IndexType > &&colIdx, Vector< IndexType > &&rowOffs, Dimensions dim)
CsrSparsityPattern	copyToExecutor (Executor dstExec) const override
	~CsrSparsityPattern ()=default
const Executor &	exec () const
const Vector< IndexType > &	colIdxs () const
Vector< IndexType > &	colIdxs ()
const Vector< IndexType > &	rowOffs () const
Vector< IndexType > &	rowOffs ()
localIdx	rows () const
localIdx	nnz () const
Dimensions	dimension () const
SparsityView< IndexType >	view () const
	Get a view representation of the matrix's data.
Public Member Functions inherited from NeoN::SupportsCopyTo< CsrSparsityPattern< IndexType > >
virtual	~SupportsCopyTo ()=default
CsrSparsityPattern< IndexType >	copyToHost () const

Detailed Description

template<typename IndexType>
class NeoN::la::CsrSparsityPattern< IndexType >

row and column index representation of a mesh

This class implements the finite volume 3/5/7 pt stencil specific generation of sparsity patterns from a given unstructured mesh

Definition at line 22 of file csrSparsityPattern.hpp.

Member Typedef Documentation

SparsityIndexType

template<typename IndexType >

using NeoN::la::CsrSparsityPattern< IndexType >::SparsityIndexType = IndexType

Definition at line 29 of file csrSparsityPattern.hpp.

Constructor & Destructor Documentation

CsrSparsityPattern() [1/2]

template<typename IndexType >

NeoN::la::CsrSparsityPattern< IndexType >::CsrSparsityPattern

(

const CsrSparsityPattern< IndexType > &

sp

)

CsrSparsityPattern() [2/2]

template<typename IndexType >

NeoN::la::CsrSparsityPattern< IndexType >::CsrSparsityPattern	(	Vector< IndexType > &&	colIdx,
		Vector< IndexType > &&	rowOffs,
		Dimensions	dim
	)

~CsrSparsityPattern()

template<typename IndexType >

NeoN::la::CsrSparsityPattern< IndexType >::~CsrSparsityPattern ( )

default

Member Function Documentation

colIdxs() [1/2]

template<typename IndexType >

Vector< IndexType > & NeoN::la::CsrSparsityPattern< IndexType >::colIdxs ( )

inline

Definition at line 51 of file csrSparsityPattern.hpp.

colIdxs() [2/2]

template<typename IndexType >

const Vector< IndexType > & NeoN::la::CsrSparsityPattern< IndexType >::colIdxs ( ) const

inline

Definition at line 49 of file csrSparsityPattern.hpp.

copyToExecutor()

template<typename IndexType >

CsrSparsityPattern NeoN::la::CsrSparsityPattern< IndexType >::copyToExecutor ( Executor  dstExec ) const

inlineoverridevirtual

Implements NeoN::SupportsCopyTo< CsrSparsityPattern< IndexType > >.

Definition at line 36 of file csrSparsityPattern.hpp.

dimension()

template<typename IndexType >

Dimensions NeoN::la::CsrSparsityPattern< IndexType >::dimension ( ) const

inline

Definition at line 63 of file csrSparsityPattern.hpp.

exec()

template<typename IndexType >

const Executor & NeoN::la::CsrSparsityPattern< IndexType >::exec ( ) const

inline

Definition at line 46 of file csrSparsityPattern.hpp.

nnz()

template<typename IndexType >

localIdx NeoN::la::CsrSparsityPattern< IndexType >::nnz ( ) const

inline

Definition at line 61 of file csrSparsityPattern.hpp.

rowOffs() [1/2]

template<typename IndexType >

Vector< IndexType > & NeoN::la::CsrSparsityPattern< IndexType >::rowOffs ( )

inline

Definition at line 57 of file csrSparsityPattern.hpp.

rowOffs() [2/2]

template<typename IndexType >

const Vector< IndexType > & NeoN::la::CsrSparsityPattern< IndexType >::rowOffs ( ) const

inline

Definition at line 54 of file csrSparsityPattern.hpp.

rows()

template<typename IndexType >

localIdx NeoN::la::CsrSparsityPattern< IndexType >::rows ( ) const

inline

Definition at line 59 of file csrSparsityPattern.hpp.

view()

template<typename IndexType >

SparsityView< IndexType > NeoN::la::CsrSparsityPattern< IndexType >::view ( ) const

inline

Get a view representation of the matrix's data.

Returns

MatrixView for easy access to matrix elements.

Definition at line 68 of file csrSparsityPattern.hpp.

---

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

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