Moose::Kokkos::Matrix Class Reference

The Kokkos wrapper class for PETSc matrix. More...

#include <KokkosMatrix.h>

Public Member Functions
	Matrix ()=default
	Default constructor.
	~Matrix ()
	Destructor.
Mat	mat ()
	Get PETSc matrix handle.
void	destroy ()
	Free all data and reset.
bool	isAlloc () const
	Get whether the matrix was allocated.
void	create (libMesh::SparseMatrix< PetscScalar > &matrix, const System &system)
	Create the matrix from a libMesh PetscMatrix.
void	close ()
	Assemble the underlying PETSc matrix.
KOKKOS_FUNCTION void	zero (PetscInt i)
	Zero a row.
KOKKOS_FUNCTION PetscScalar &	operator() (PetscInt i, PetscInt j) const
	Get an entry with given row and column indices.
auto &	operator= (PetscScalar scalar)
	Assign a scalar value uniformly.

Private Member Functions
KOKKOS_FUNCTION PetscInt	find (PetscInt i, PetscInt j) const
	Get the index of given row and column indices.

Private Attributes
Mat	_matrix = PETSC_NULLPTR
	PETSc matrix.
PetscCount	_nr = 0
	Number of rows local to this process.
bool	_is_host = false
	Flag whether the PETSc matrix is a host matrix.
bool	_is_alloc = false
	Flag whether the matrix was allocated.
Array< PetscInt >	_col_idx
	CSR vectors on device.
Array< PetscInt >	_row_idx
Array< PetscInt >	_row_ptr
Array< PetscScalar >	_val

Detailed Description

The Kokkos wrapper class for PETSc matrix.

Definition at line 28 of file KokkosMatrix.h.

Constructor & Destructor Documentation

Matrix()

Moose::Kokkos::Matrix::Matrix ( )

default

Default constructor.

~Matrix()

Moose::Kokkos::Matrix::~Matrix ( )

inline

Destructor.

Definition at line 38 of file KokkosMatrix.h.

{ destroy(); }

Member Function Documentation

close()

void Moose::Kokkos::Matrix::close

(

)

Assemble the underlying PETSc matrix.

create()

void Moose::Kokkos::Matrix::create	(	libMesh::SparseMatrix< PetscScalar > &	matrix,
		const System &	system
	)

Create the matrix from a libMesh PetscMatrix.

Parameters

matrix	The libMesh PetscMatrix
system	The Kokkos system

destroy()

void Moose::Kokkos::Matrix::destroy

(

)

Free all data and reset.

Referenced by ~Matrix().

find()

KOKKOS_FUNCTION PetscInt Moose::Kokkos::Matrix::find ( PetscInt  i, PetscInt  j  ) const

inlineprivate

Get the index of given row and column indices.

Parameters

i	The row index local to this process
j	The global column index

Returns

The index into the nonzero vector, and -1 if not found

Definition at line 140 of file KokkosMatrix.h.

{
  KOKKOS_ASSERT(i < _nr);
 
  auto begin = _col_idx.data() + _row_ptr[i];
  auto end = _col_idx.data() + _row_ptr[i + 1];
  auto target = Utils::find(j, begin, end);
 
  if (target == end)
    return -1;
  else
    return target - _col_idx.data();
}

Referenced by operator()().

isAlloc()

bool Moose::Kokkos::Matrix::isAlloc ( ) const

inline

Get whether the matrix was allocated.

Returns

Whether the matrix was allocated

Definition at line 53 of file KokkosMatrix.h.

{ return _is_alloc; }

mat()

Mat Moose::Kokkos::Matrix::mat ( )

inline

Get PETSc matrix handle.

Definition at line 42 of file KokkosMatrix.h.

{ return _matrix; }

operator()()

KOKKOS_FUNCTION PetscScalar & Moose::Kokkos::Matrix::operator() ( PetscInt  i, PetscInt  j  ) const

inline

Get an entry with given row and column indices.

Parameters

i	The row index local to this process
j	The global column index

Returns

The reference of the element

Definition at line 80 of file KokkosMatrix.h.

  {
    auto idx = find(i, j);
 
    KOKKOS_ASSERT(idx != -1);
 
    return _val[idx];
  }

operator=()

auto & Moose::Kokkos::Matrix::operator= ( PetscScalar  scalar )

inline

Assign a scalar value uniformly.

Parameters

scalar

The scalar value to be assigned

Definition at line 92 of file KokkosMatrix.h.

  {
    _val = scalar;
 
    return *this;
  }

zero()

KOKKOS_FUNCTION void Moose::Kokkos::Matrix::zero ( PetscInt  i )

inline

Zero a row.

Parameters

i	The row index local to this process to be zeroed

Definition at line 69 of file KokkosMatrix.h.

  {
    for (PetscInt j = _row_ptr[i]; j < _row_ptr[i + 1]; ++j)
      _val[j] = 0;
  }

Member Data Documentation

_col_idx

Array<PetscInt> Moose::Kokkos::Matrix::_col_idx

private

CSR vectors on device.

Definition at line 123 of file KokkosMatrix.h.

Referenced by find().

_is_alloc

bool Moose::Kokkos::Matrix::_is_alloc = false

private

Flag whether the matrix was allocated.

Definition at line 135 of file KokkosMatrix.h.

Referenced by isAlloc().

_is_host

bool Moose::Kokkos::Matrix::_is_host = false

private

Flag whether the PETSc matrix is a host matrix.

Definition at line 131 of file KokkosMatrix.h.

_matrix

Mat Moose::Kokkos::Matrix::_matrix = PETSC_NULLPTR

private

PETSc matrix.

Definition at line 114 of file KokkosMatrix.h.

Referenced by mat().

_nr

PetscCount Moose::Kokkos::Matrix::_nr = 0

private

Number of rows local to this process.

Definition at line 118 of file KokkosMatrix.h.

Referenced by find().

_row_idx

Array<PetscInt> Moose::Kokkos::Matrix::_row_idx

private

Definition at line 124 of file KokkosMatrix.h.

_row_ptr

Array<PetscInt> Moose::Kokkos::Matrix::_row_ptr

private

Definition at line 125 of file KokkosMatrix.h.

Referenced by find(), and zero().

_val

Array<PetscScalar> Moose::Kokkos::Matrix::_val

private

Definition at line 126 of file KokkosMatrix.h.

Referenced by operator()(), operator=(), and zero().

---

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

• include/kokkos/systems/KokkosMatrix.h