KratosMultiphysics
KRATOS Multiphysics (Kratos) is a framework for building parallel, multi-disciplinary simulation software, aiming at modularity, extensibility, and high performance. Kratos is written in C++, and counts with an extensive Python interface.
List of all members
Kratos::EigenDenseHouseholderQRDecomposition< TDenseSpace > Class Template Reference

#include <eigen_dense_householder_qr_decomposition.h>

Inheritance diagram for Kratos::EigenDenseHouseholderQRDecomposition< TDenseSpace >:
Collaboration diagram for Kratos::EigenDenseHouseholderQRDecomposition< TDenseSpace >:

Public Member Functions

Life Cycle
 EigenDenseHouseholderQRDecomposition ()=default
 
- Public Member Functions inherited from Kratos::DenseQRDecomposition< TDenseSpace >
 DenseQRDecomposition ()=default
 
virtual ~DenseQRDecomposition ()=default
 
 KRATOS_CLASS_POINTER_DEFINITION (DenseQRDecomposition)
 Definition of the shared pointer of the class. More...
 
virtual void Compute (MatrixType &rInputMatrix)=0
 Compute the QR Computes the QR Decomposition (QR) of the given imput matrix. More...
 
virtual void Compute (MatrixType &rInputMatrix, MatrixType &rMatrixQ, MatrixType &rMatrixR)=0
 Compute the QR Computes the QR (QR) of the given input matrix. More...
 
virtual void Solve (MatrixType &rB, MatrixType &rX) const=0
 Solves the problem Ax=b Being A the input matrix, this method solves the problem Ax = b. More...
 
virtual void Solve (const VectorType &rB, VectorType &rX) const=0
 Solves the problem Ax=b Being A the input matrix, this method solves the problem Ax = b. More...
 
virtual void MatrixQ (MatrixType &rMatrixQ) const=0
 Unitary matrix getter If computed, this method sets the unitary matrix in the provided array. More...
 
virtual void MatrixR (MatrixType &rMatrixR) const=0
 Upper triangular matrix getter If computed, this method sets the upper triangular matrix in the provided array. More...
 
virtual void MatrixP (MatrixType &rMatrixP) const=0
 Pivoting matrix getter If computed, this method sets the pivoting matrix. More...
 

Type Definitions

typedef TDenseSpace::DataType DataType
 
typedef TDenseSpace::VectorType VectorType
 
typedef TDenseSpace::MatrixType MatrixType
 
using EigenVector = Kratos::EigenDynamicVector< DataType >
 
using EigenMatrix = Kratos::EigenDynamicMatrix< DataType >
 
 KRATOS_CLASS_POINTER_DEFINITION (EigenDenseHouseholderQRDecomposition)
 Definition of the shared pointer of the class. More...
 

Operations

void Compute (MatrixType &rInputMatrix) override
 
void Compute (MatrixType &rInputMatrix, MatrixType &rMatrixQ, MatrixType &rMatrixR) override
 
void Solve (MatrixType &rB, MatrixType &rX) const override
 
void Solve (const VectorType &rB, VectorType &rX) const override
 
void MatrixQ (MatrixType &rMatrixQ) const override
 
void MatrixR (MatrixType &rMatrixR) const override
 
void MatrixP (MatrixType &rMatrixP) const override
 
std::size_t Rank () const override
 Rank of the provided array Calculates and returns the rank of the array decomposed with the QR. More...
 
void PrintInfo (std::ostream &rOStream) const override
 QR information Outputs the QR class information. More...
 
static std::string Name ()
 

Additional Inherited Members

- Public Types inherited from Kratos::DenseQRDecomposition< TDenseSpace >
typedef TDenseSpaceType::DataType DataType
 
typedef TDenseSpaceType::VectorType VectorType
 
typedef TDenseSpaceType::MatrixType MatrixType
 
- Static Public Member Functions inherited from Kratos::DenseQRDecomposition< TDenseSpace >
static std::string Name ()
 Name of the QR Returns a string containing the name of the current QR decomposition. More...
 

Member Typedef Documentation

◆ DataType

template<class TDenseSpace >
typedef TDenseSpace::DataType Kratos::EigenDenseHouseholderQRDecomposition< TDenseSpace >::DataType

◆ EigenMatrix

◆ EigenVector

◆ MatrixType

template<class TDenseSpace >
typedef TDenseSpace::MatrixType Kratos::EigenDenseHouseholderQRDecomposition< TDenseSpace >::MatrixType

◆ VectorType

template<class TDenseSpace >
typedef TDenseSpace::VectorType Kratos::EigenDenseHouseholderQRDecomposition< TDenseSpace >::VectorType

Constructor & Destructor Documentation

◆ EigenDenseHouseholderQRDecomposition()

template<class TDenseSpace >
Kratos::EigenDenseHouseholderQRDecomposition< TDenseSpace >::EigenDenseHouseholderQRDecomposition ( )
default

Member Function Documentation

◆ Compute() [1/2]

template<class TDenseSpace >
void Kratos::EigenDenseHouseholderQRDecomposition< TDenseSpace >::Compute ( MatrixType rInputMatrix)
inlineoverride

◆ Compute() [2/2]

template<class TDenseSpace >
void Kratos::EigenDenseHouseholderQRDecomposition< TDenseSpace >::Compute ( MatrixType rInputMatrix,
MatrixType rMatrixQ,
MatrixType rMatrixR 
)
inlineoverride

◆ KRATOS_CLASS_POINTER_DEFINITION()

template<class TDenseSpace >
Kratos::EigenDenseHouseholderQRDecomposition< TDenseSpace >::KRATOS_CLASS_POINTER_DEFINITION ( EigenDenseHouseholderQRDecomposition< TDenseSpace >  )

Definition of the shared pointer of the class.

◆ MatrixP()

template<class TDenseSpace >
void Kratos::EigenDenseHouseholderQRDecomposition< TDenseSpace >::MatrixP ( MatrixType rMatrixP) const
inlineoverride

◆ MatrixQ()

template<class TDenseSpace >
void Kratos::EigenDenseHouseholderQRDecomposition< TDenseSpace >::MatrixQ ( MatrixType rMatrixQ) const
inlineoverride

◆ MatrixR()

template<class TDenseSpace >
void Kratos::EigenDenseHouseholderQRDecomposition< TDenseSpace >::MatrixR ( MatrixType rMatrixR) const
inlineoverride

◆ Name()

template<class TDenseSpace >
static std::string Kratos::EigenDenseHouseholderQRDecomposition< TDenseSpace >::Name ( )
inlinestatic

◆ PrintInfo()

template<class TDenseSpace >
void Kratos::EigenDenseHouseholderQRDecomposition< TDenseSpace >::PrintInfo ( std::ostream &  rOStream) const
inlineoverridevirtual

QR information Outputs the QR class information.

Parameters
rOStreamInformation output

Implements Kratos::DenseQRDecomposition< TDenseSpace >.

◆ Rank()

template<class TDenseSpace >
std::size_t Kratos::EigenDenseHouseholderQRDecomposition< TDenseSpace >::Rank ( ) const
inlineoverridevirtual

Rank of the provided array Calculates and returns the rank of the array decomposed with the QR.

Returns
std::size_t Rank of the provided array

Implements Kratos::DenseQRDecomposition< TDenseSpace >.

◆ Solve() [1/2]

template<class TDenseSpace >
void Kratos::EigenDenseHouseholderQRDecomposition< TDenseSpace >::Solve ( const VectorType rB,
VectorType rX 
) const
inlineoverride

◆ Solve() [2/2]

template<class TDenseSpace >
void Kratos::EigenDenseHouseholderQRDecomposition< TDenseSpace >::Solve ( MatrixType rB,
MatrixType rX 
) const
inlineoverride

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