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

Complex Periodic Band Matrix. More...

#include "matrix.hpp"

+ Collaboration diagram for orb5x::spclibs::ZPeriodicMat:

Public Member Functions

bool is_initialized () const
 
 ZPeriodicMat ()=default
 Construct an empty complex periodic-matrix descriptor.
 

Public Attributes

ZGBMat mat
 Factorizable nonperiodic band part \(B\).
 
Kokkos::View< Complex **, Kokkos::HostSpace > matu
 Low-rank Woodbury factor \(U\).
 
Kokkos::View< Complex **, Kokkos::HostSpace > matvt
 Transposed low-rank Woodbury factor \(V^T\).
 
int nterms = 0
 Informational count of assembled nonzero terms.
 

Detailed Description

Complex Periodic Band Matrix.

Constructor & Destructor Documentation

◆ ZPeriodicMat()

orb5x::spclibs::ZPeriodicMat::ZPeriodicMat ( )
default

Construct an empty complex periodic-matrix descriptor.

Member Function Documentation

◆ is_initialized()

bool orb5x::spclibs::ZPeriodicMat::is_initialized ( ) const
inline
Returns
true when the complex core band matrix is allocated.

References orb5x::spclibs::ZGBMat::is_initialized(), and mat.

Member Data Documentation

◆ mat

ZGBMat orb5x::spclibs::ZPeriodicMat::mat

Factorizable nonperiodic band part \(B\).

Referenced by is_initialized().

◆ matu

Kokkos::View<Complex**, Kokkos::HostSpace> orb5x::spclibs::ZPeriodicMat::matu

Low-rank Woodbury factor \(U\).

◆ matvt

Kokkos::View<Complex**, Kokkos::HostSpace> orb5x::spclibs::ZPeriodicMat::matvt

Transposed low-rank Woodbury factor \(V^T\).

◆ nterms

int orb5x::spclibs::ZPeriodicMat::nterms = 0

Informational count of assembled nonzero terms.


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