ORB5X 1.0.0
Performance-portable global electromagnetic gyrokinetic PIC code
orb5x::spclibs::PBMat Struct Reference

Packed Band Matrix (LAPACK PB storage format) More...

#include "matrix.hpp"

Public Member Functions

bool is_initialized () const
 
int lda () const
 
 PBMat ()=default
 Construct an empty, unallocated packed-band descriptor.
 

Public Attributes

int kmat = 0
 Matrix identifier.
 
int ku = 0
 Number of superdiagonals.
 
int nterms = 0
 Number of non-zero terms.
 
int rank = 0
 Matrix rank (= number of rows/columns)
 
Kokkos::View< Real **, Kokkos::HostSpace > val
 Matrix values in packed band storage.
 

Detailed Description

Packed Band Matrix (LAPACK PB storage format)

Storage format for symmetric positive definite band matrices. Uses LAPACK routines DPBTRF, DPBTRS. Only stores upper triangle (ku superdiagonals).

Constructor & Destructor Documentation

◆ PBMat()

orb5x::spclibs::PBMat::PBMat ( )
default

Construct an empty, unallocated packed-band descriptor.

Member Function Documentation

◆ is_initialized()

bool orb5x::spclibs::PBMat::is_initialized ( ) const
inline
Returns
true when packed-band storage is allocated.

References val.

◆ lda()

int orb5x::spclibs::PBMat::lda ( ) const
inline
Returns
LAPACK packed-band leading dimension ku+1.

References ku.

Member Data Documentation

◆ kmat

int orb5x::spclibs::PBMat::kmat = 0

Matrix identifier.

◆ ku

int orb5x::spclibs::PBMat::ku = 0

Number of superdiagonals.

Referenced by lda().

◆ nterms

int orb5x::spclibs::PBMat::nterms = 0

Number of non-zero terms.

◆ rank

int orb5x::spclibs::PBMat::rank = 0

Matrix rank (= number of rows/columns)

◆ val

Kokkos::View<Real**, Kokkos::HostSpace> orb5x::spclibs::PBMat::val

Matrix values in packed band storage.

Referenced by is_initialized().


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