MFEM  v4.6.0
Finite element discretization library
Public Member Functions | List of all members
mfem::ComplexCholeskyFactors Class Reference

#include <complex_densemat.hpp>

Inheritance diagram for mfem::ComplexCholeskyFactors:
[legend]
Collaboration diagram for mfem::ComplexCholeskyFactors:
[legend]

Public Member Functions

 ComplexCholeskyFactors ()
 
 ComplexCholeskyFactors (double *data_r_, double *data_i_)
 
virtual bool Factor (int m, double TOL=0.0)
 Compute the Cholesky factorization of the current matrix. More...
 
virtual std::complex< double > Det (int m) const
 
void LMult (int m, int n, double *X_r, double *X_i) const
 
void UMult (int m, int n, double *X_r, double *X_i) const
 
void LSolve (int m, int n, double *X_r, double *X_i) const
 
void USolve (int m, int n, double *X_r, double *X_i) const
 
virtual void Solve (int m, int n, double *X_r, double *X_i) const
 
void RightSolve (int m, int n, double *X_r, double *X_i) const
 
virtual void GetInverseMatrix (int m, double *X_r, double *X_i) const
 Assuming L.L^H = A factored data of size (m x m), compute X <- A^{-1}. More...
 
- Public Member Functions inherited from mfem::ComplexFactors
 ComplexFactors ()
 
 ComplexFactors (double *data_r_, double *data_i_)
 
void SetComplexData (int m)
 
void ResetComplexData (int m)
 
virtual ~ComplexFactors ()
 

Additional Inherited Members

- Public Attributes inherited from mfem::ComplexFactors
double * data_r = nullptr
 
double * data_i = nullptr
 
std::complex< double > * data = nullptr
 
- Protected Member Functions inherited from mfem::ComplexFactors
std::complex< double > * RealToComplex (int m, const double *x_r, const double *x_i) const
 
void ComplexToReal (int m, const std::complex< double > *x, double *x_r, double *x_i) const
 

Detailed Description

Class that can compute Cholesky factorizations of external data of an Hermitian positive matrix and perform various operations with the factored data.

Definition at line 186 of file complex_densemat.hpp.

Constructor & Destructor Documentation

◆ ComplexCholeskyFactors() [1/2]

mfem::ComplexCholeskyFactors::ComplexCholeskyFactors ( )
inline

With this constructor, the (public) data should be set explicitly before calling class methods.

Definition at line 192 of file complex_densemat.hpp.

◆ ComplexCholeskyFactors() [2/2]

mfem::ComplexCholeskyFactors::ComplexCholeskyFactors ( double *  data_r_,
double *  data_i_ 
)
inline

Definition at line 194 of file complex_densemat.hpp.

Member Function Documentation

◆ Det()

std::complex< double > mfem::ComplexCholeskyFactors::Det ( int  m) const
virtual

Assuming LL^H = A factored data of size (m x m), compute |A| from the diagonal values of L

Reimplemented from mfem::ComplexFactors.

Definition at line 789 of file complex_densemat.cpp.

◆ Factor()

bool mfem::ComplexCholeskyFactors::Factor ( int  m,
double  TOL = 0.0 
)
virtual

Compute the Cholesky factorization of the current matrix.

Factorize the current matrix of size (m x m) overwriting it with the Cholesky factors. The factorization is such that LL^H = A, where A is the original matrix

Parameters
[in]msize of the square matrix
[in]TOLoptional fuzzy comparison tolerance. Defaults to 0.0.
Returns
status set to true if successful, otherwise, false.

Reimplemented from mfem::ComplexFactors.

Definition at line 749 of file complex_densemat.cpp.

◆ GetInverseMatrix()

void mfem::ComplexCholeskyFactors::GetInverseMatrix ( int  m,
double *  X_r,
double *  X_i 
) const
virtual

Assuming L.L^H = A factored data of size (m x m), compute X <- A^{-1}.

Reimplemented from mfem::ComplexFactors.

Definition at line 978 of file complex_densemat.cpp.

◆ LMult()

void mfem::ComplexCholeskyFactors::LMult ( int  m,
int  n,
double *  X_r,
double *  X_i 
) const

Assuming L.L^H = A factored data of size (m x m), compute X <- L X, for a matrix X of size (m x n).

Definition at line 799 of file complex_densemat.cpp.

◆ LSolve()

void mfem::ComplexCholeskyFactors::LSolve ( int  m,
int  n,
double *  X_r,
double *  X_i 
) const

Assuming L L^H = A factored data of size (m x m), compute X <- L^{-1} X, for a matrix X of size (m x n).

Definition at line 844 of file complex_densemat.cpp.

◆ RightSolve()

void mfem::ComplexCholeskyFactors::RightSolve ( int  m,
int  n,
double *  X_r,
double *  X_i 
) const

Assuming L.L^H = A factored data of size (m x m), compute X <- X A^{-1}, for a matrix X of size (n x m).

Definition at line 926 of file complex_densemat.cpp.

◆ Solve()

void mfem::ComplexCholeskyFactors::Solve ( int  m,
int  n,
double *  X_r,
double *  X_i 
) const
virtual

Assuming L.L^H = A factored data of size (m x m), compute X <- A^{-1} X, for a matrix X of size (m x n).

Reimplemented from mfem::ComplexFactors.

Definition at line 909 of file complex_densemat.cpp.

◆ UMult()

void mfem::ComplexCholeskyFactors::UMult ( int  m,
int  n,
double *  X_r,
double *  X_i 
) const

Assuming L.L^H = A factored data of size (m x m), compute X <- L^t X, for a matrix X of size (m x n).

Definition at line 822 of file complex_densemat.cpp.

◆ USolve()

void mfem::ComplexCholeskyFactors::USolve ( int  m,
int  n,
double *  X_r,
double *  X_i 
) const

Assuming L L^H = A factored data of size (m x m), compute X <- L^{-t} X, for a matrix X of size (m x n).

Definition at line 876 of file complex_densemat.cpp.


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