ViennaSHE 1.3.0
Free open-source semiconductor device simulator using spherical harmonics expansions techniques.
Public Types | Public Member Functions | List of all members
viennashe::solvers::PETSC_matrix< NumericT, VectorType > Class Template Reference

Wrapper class to the PETSC matrix. More...

#include <petsc.hpp>

Public Types

typedef std::size_t size_type
 
typedef size_type SizeType
 
typedef PETSC_vector< NumericT, VectorType > row_type
 
typedef PETSC_vector< NumericT, VectorType > RowType
 

Public Member Functions

 PETSC_matrix (const viennashe::math::sparse_matrix< NumericT > &copymat)
 Wrapper class to the PETSC matrix. More...
 
 ~PETSC_matrix ()
 
void solve (PETSC_vector< NumericT, VectorType > &b)
 Wrapper class to the PETSC matrix. More...
 
size_type size1 () const
 
size_type size2 () const
 
self_type & operator= (double other)
 
PetscReal getNorm () const
 
KSPConvergedReason get_Creason ()
 
int get_Citer ()
 
void setNorm (PetscReal norm)
 
size_type getSize1 () const
 
void setSize1 (size_type size1)
 
size_type getSize2 () const
 
void setSize2 (size_type size2)
 
const Mat & getA ()
 
int getIndex () const
 
void setIndex (int index)
 
PetscInt getNlocal1 () const
 
void setNlocal1 (PetscInt nlocal1)
 
PetscInt getNlocal2 () const
 
void setNlocal2 (PetscInt nlocal2)
 
int getIter () const
 
void setIter (int iter)
 
PetscInt getRend () const
 
void setRend (PetscInt rend)
 
PetscInt getRstart () const
 
void setRstart (PetscInt rstart)
 

Detailed Description

template<typename NumericT, typename VectorType>
class viennashe::solvers::PETSC_matrix< NumericT, VectorType >

Wrapper class to the PETSC matrix.

Definition at line 131 of file petsc.hpp.

Member Typedef Documentation

◆ row_type

template<typename NumericT , typename VectorType >
typedef PETSC_vector<NumericT, VectorType> viennashe::solvers::PETSC_matrix< NumericT, VectorType >::row_type

Definition at line 276 of file petsc.hpp.

◆ RowType

template<typename NumericT , typename VectorType >
typedef PETSC_vector<NumericT, VectorType> viennashe::solvers::PETSC_matrix< NumericT, VectorType >::RowType

Definition at line 277 of file petsc.hpp.

◆ size_type

template<typename NumericT , typename VectorType >
typedef std::size_t viennashe::solvers::PETSC_matrix< NumericT, VectorType >::size_type

Definition at line 136 of file petsc.hpp.

◆ SizeType

template<typename NumericT , typename VectorType >
typedef size_type viennashe::solvers::PETSC_matrix< NumericT, VectorType >::SizeType

Definition at line 137 of file petsc.hpp.

Constructor & Destructor Documentation

◆ PETSC_matrix()

template<typename NumericT , typename VectorType >
viennashe::solvers::PETSC_matrix< NumericT, VectorType >::PETSC_matrix ( const viennashe::math::sparse_matrix< NumericT > &  copymat)
inline

Wrapper class to the PETSC matrix.

Parameters
copymat- Matrix to be copied to PETSc

Definition at line 144 of file petsc.hpp.

◆ ~PETSC_matrix()

template<typename NumericT , typename VectorType >
viennashe::solvers::PETSC_matrix< NumericT, VectorType >::~PETSC_matrix ( )
inline

Definition at line 241 of file petsc.hpp.

Member Function Documentation

◆ get_Citer()

template<typename NumericT , typename VectorType >
int viennashe::solvers::PETSC_matrix< NumericT, VectorType >::get_Citer ( )
inline

Definition at line 299 of file petsc.hpp.

◆ get_Creason()

template<typename NumericT , typename VectorType >
KSPConvergedReason viennashe::solvers::PETSC_matrix< NumericT, VectorType >::get_Creason ( )
inline

Definition at line 292 of file petsc.hpp.

◆ getA()

template<typename NumericT , typename VectorType >
const Mat & viennashe::solvers::PETSC_matrix< NumericT, VectorType >::getA ( )
inline

Definition at line 335 of file petsc.hpp.

◆ getIndex()

template<typename NumericT , typename VectorType >
int viennashe::solvers::PETSC_matrix< NumericT, VectorType >::getIndex ( ) const
inline

Definition at line 341 of file petsc.hpp.

◆ getIter()

template<typename NumericT , typename VectorType >
int viennashe::solvers::PETSC_matrix< NumericT, VectorType >::getIter ( ) const
inline

Definition at line 377 of file petsc.hpp.

◆ getNlocal1()

template<typename NumericT , typename VectorType >
PetscInt viennashe::solvers::PETSC_matrix< NumericT, VectorType >::getNlocal1 ( ) const
inline

Definition at line 353 of file petsc.hpp.

◆ getNlocal2()

template<typename NumericT , typename VectorType >
PetscInt viennashe::solvers::PETSC_matrix< NumericT, VectorType >::getNlocal2 ( ) const
inline

Definition at line 365 of file petsc.hpp.

◆ getNorm()

template<typename NumericT , typename VectorType >
PetscReal viennashe::solvers::PETSC_matrix< NumericT, VectorType >::getNorm ( ) const
inline

Definition at line 287 of file petsc.hpp.

◆ getRend()

template<typename NumericT , typename VectorType >
PetscInt viennashe::solvers::PETSC_matrix< NumericT, VectorType >::getRend ( ) const
inline

Definition at line 389 of file petsc.hpp.

◆ getRstart()

template<typename NumericT , typename VectorType >
PetscInt viennashe::solvers::PETSC_matrix< NumericT, VectorType >::getRstart ( ) const
inline

Definition at line 401 of file petsc.hpp.

◆ getSize1()

template<typename NumericT , typename VectorType >
size_type viennashe::solvers::PETSC_matrix< NumericT, VectorType >::getSize1 ( ) const
inline

Definition at line 311 of file petsc.hpp.

◆ getSize2()

template<typename NumericT , typename VectorType >
size_type viennashe::solvers::PETSC_matrix< NumericT, VectorType >::getSize2 ( ) const
inline

Definition at line 323 of file petsc.hpp.

◆ operator=()

template<typename NumericT , typename VectorType >
self_type & viennashe::solvers::PETSC_matrix< NumericT, VectorType >::operator= ( double  other)
inline

Definition at line 280 of file petsc.hpp.

◆ setIndex()

template<typename NumericT , typename VectorType >
void viennashe::solvers::PETSC_matrix< NumericT, VectorType >::setIndex ( int  index)
inline

Definition at line 347 of file petsc.hpp.

◆ setIter()

template<typename NumericT , typename VectorType >
void viennashe::solvers::PETSC_matrix< NumericT, VectorType >::setIter ( int  iter)
inline

Definition at line 383 of file petsc.hpp.

◆ setNlocal1()

template<typename NumericT , typename VectorType >
void viennashe::solvers::PETSC_matrix< NumericT, VectorType >::setNlocal1 ( PetscInt  nlocal1)
inline

Definition at line 359 of file petsc.hpp.

◆ setNlocal2()

template<typename NumericT , typename VectorType >
void viennashe::solvers::PETSC_matrix< NumericT, VectorType >::setNlocal2 ( PetscInt  nlocal2)
inline

Definition at line 371 of file petsc.hpp.

◆ setNorm()

template<typename NumericT , typename VectorType >
void viennashe::solvers::PETSC_matrix< NumericT, VectorType >::setNorm ( PetscReal  norm)
inline

Definition at line 305 of file petsc.hpp.

◆ setRend()

template<typename NumericT , typename VectorType >
void viennashe::solvers::PETSC_matrix< NumericT, VectorType >::setRend ( PetscInt  rend)
inline

Definition at line 395 of file petsc.hpp.

◆ setRstart()

template<typename NumericT , typename VectorType >
void viennashe::solvers::PETSC_matrix< NumericT, VectorType >::setRstart ( PetscInt  rstart)
inline

Definition at line 407 of file petsc.hpp.

◆ setSize1()

template<typename NumericT , typename VectorType >
void viennashe::solvers::PETSC_matrix< NumericT, VectorType >::setSize1 ( size_type  size1)
inline

Definition at line 317 of file petsc.hpp.

◆ setSize2()

template<typename NumericT , typename VectorType >
void viennashe::solvers::PETSC_matrix< NumericT, VectorType >::setSize2 ( size_type  size2)
inline

Definition at line 329 of file petsc.hpp.

◆ size1()

template<typename NumericT , typename VectorType >
size_type viennashe::solvers::PETSC_matrix< NumericT, VectorType >::size1 ( ) const
inline

Definition at line 264 of file petsc.hpp.

◆ size2()

template<typename NumericT , typename VectorType >
size_type viennashe::solvers::PETSC_matrix< NumericT, VectorType >::size2 ( ) const
inline

Definition at line 269 of file petsc.hpp.

◆ solve()

template<typename NumericT , typename VectorType >
void viennashe::solvers::PETSC_matrix< NumericT, VectorType >::solve ( PETSC_vector< NumericT, VectorType > &  b)
inline

Wrapper class to the PETSC matrix.

Parameters
b- right hand term

Definition at line 251 of file petsc.hpp.

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