Reference documentation for deal.II version Git ee8a81293c 2020-10-19 10:17:29 -0400
\(\newcommand{\dealvcentcolon}{\mathrel{\mathop{:}}}\) \(\newcommand{\dealcoloneq}{\dealvcentcolon\mathrel{\mkern-1.2mu}=}\) \(\newcommand{\jump}[1]{\left[\!\left[ #1 \right]\!\right]}\) \(\newcommand{\average}[1]{\left\{\!\left\{ #1 \right\}\!\right\}}\)
Enumerations | Functions | Variables
LAPACKSupport Namespace Reference

Enumerations

enum  State {
  matrix, inverse_matrix, lu, cholesky,
  eigenvalues, svd, inverse_svd, unusable = 0x8000
}
 
enum  Property {
  general = 0, symmetric = 1, upper_triangular = 2, lower_triangular = 4,
  diagonal = 6, hessenberg = 8
}
 

Functions

const char * state_name (State s)
 
const char * property_name (const Property s)
 
static ::ExceptionBaseExcErrorCode (std::string arg1, types::blas_int arg2)
 
static ::ExceptionBaseExcState (State arg1)
 
static ::ExceptionBaseExcProperty (Property arg1)
 
static ::ExceptionBaseExcMissing (std::string arg1)
 

Variables

static const char A = 'A'
 
static const char N = 'N'
 
static const char O = 'O'
 
static const char T = 'T'
 
static const char U = 'U'
 
static const char L = 'L'
 
static const char V = 'V'
 
static const types::blas_int zero = 0
 
static const types::blas_int one = 1
 

Detailed Description

A namespace containing constants, exceptions, enumerations, and other utilities used by the deal.II LAPACK bindings.

Enumeration Type Documentation

◆ State

Most of the LAPACK functions one can apply to a matrix (e.g., by calling the member functions of this class) change its content in some ways. For example, they may invert the matrix, or may replace it by a matrix whose columns represent the eigenvectors of the original content of the matrix. The elements of this enumeration are therefore used to track what is currently being stored by this object.

Enumerator
matrix 

Contents is actually a matrix.

inverse_matrix 

Contents is the inverse of a matrix.

lu 

Contents is an LU decomposition.

cholesky 

Contents is a Cholesky decomposition.

eigenvalues 

Eigenvalue vector is filled.

svd 

Matrix contains singular value decomposition,.

inverse_svd 

Matrix is the inverse of a singular value decomposition.

unusable 

Contents is something useless.

Definition at line 55 of file lapack_support.h.

◆ Property

A matrix can have certain features allowing for optimization, but hard to test. These are listed here.

Enumerator
general 

No special properties.

symmetric 

Matrix is symmetric.

upper_triangular 

Matrix is upper triangular.

lower_triangular 

Matrix is lower triangular.

diagonal 

Matrix is diagonal.

hessenberg 

Matrix is in upper Hessenberg form.

Definition at line 108 of file lapack_support.h.

Function Documentation

◆ state_name()

const char* LAPACKSupport::state_name ( State  s)
inline

Function printing the name of a State.

Definition at line 79 of file lapack_support.h.

◆ property_name()

const char* LAPACKSupport::property_name ( const Property  s)
inline

Function printing the name of a Property.

Definition at line 128 of file lapack_support.h.

Variable Documentation

◆ A

const char LAPACKSupport::A = 'A'
static

Character constant.

Definition at line 153 of file lapack_support.h.

◆ N

const char LAPACKSupport::N = 'N'
static

Character constant.

Definition at line 157 of file lapack_support.h.

◆ O

const char LAPACKSupport::O = 'O'
static

Character constant.

Definition at line 161 of file lapack_support.h.

◆ T

const char LAPACKSupport::T = 'T'
static

Character constant.

Definition at line 165 of file lapack_support.h.

◆ U

const char LAPACKSupport::U = 'U'
static

Character constant.

Definition at line 169 of file lapack_support.h.

◆ L

const char LAPACKSupport::L = 'L'
static

Character constant.

Definition at line 173 of file lapack_support.h.

◆ V

const char LAPACKSupport::V = 'V'
static

Character constant.

Definition at line 177 of file lapack_support.h.

◆ zero

const types::blas_int LAPACKSupport::zero = 0
static

Integer constant.

Definition at line 181 of file lapack_support.h.

◆ one

const types::blas_int LAPACKSupport::one = 1
static

Integer constant.

Definition at line 185 of file lapack_support.h.