Kratos::ConditionNumberUtility Class Reference

Utility to compute the condition number. More...

#include <condition_number_utility.h>

Collaboration diagram for Kratos::ConditionNumberUtility:

Public Member Functions
Operators
	ConditionNumberUtility ()
	Default constructor. More...
	ConditionNumberUtility (LinearSolverType::Pointer pEigenSolverMax, LinearSolverType::Pointer pEigenSolverMin)
	Default constructor. More...
virtual	~ConditionNumberUtility ()
	Destructor. More...
Operations
double	GetConditionNumber (SparseMatrixType &rInputMatrix)
	This function computes using the inverse power method the minimal eigenvalue. More...
double	GetConditionNumber (SparseMatrixType &rInputMatrix, LinearSolverType::Pointer pEigenSolverMax, LinearSolverType::Pointer pEigenSolverMin)
	This function computes using the inverse power method the minimal eigenvalue. More...

Type Definitions
typedef std::size_t	SizeType
	The sisze type. More...
typedef std::size_t	IndexType
	The index type. More...
typedef UblasSpace< double, CompressedMatrix, boost::numeric::ublas::vector< double > >	SparseSpaceType
	The sparse space considered (the one containing the compressed matrix) More...
typedef UblasSpace< double, Matrix, Vector >	LocalSpaceType
	The dense space considered. More...
typedef SparseSpaceType::MatrixType	SparseMatrixType
	The compressed matrix. More...
typedef SparseSpaceType::VectorType	VectorType
	The vector considered. More...
typedef LocalSpaceType::MatrixType	DenseMatrixType
	The dense matrix. More...
typedef LocalSpaceType::VectorType	DenseVectorType
	The dense vector. More...
typedef LinearSolver< SparseSpaceType, LocalSpaceType >	LinearSolverType
	The definion of the linear solver. More...
typedef Reorderer< SparseSpaceType, LocalSpaceType >	ReordererType
	The reorder considered. More...
typedef SkylineLUFactorizationSolver< SparseSpaceType, LocalSpaceType, ReordererType >	SkylineLUFactorizationSolverType
	Skyline solver definion. More...
typedef PowerIterationHighestEigenvalueSolver< SparseSpaceType, LocalSpaceType, LinearSolverType >	PowerIterationHighestEigenvalueSolverType
	Power iteration solver for the highest eigenvalue. More...
typedef PowerIterationEigenvalueSolver< SparseSpaceType, LocalSpaceType, LinearSolverType >	PowerIterationEigenvalueSolverType
	Power iteration solver for the lowest eigenvalue. More...
	KRATOS_CLASS_POINTER_DEFINITION (ConditionNumberUtility)
	Pointer definition of ConditionNumberUtility. More...

Detailed Description

Utility to compute the condition number.

This utility is used in order to compute the condition number of a sparse matrix. Please provide an eigensolver for the maximum and minimum eigenvalue or the power iterations solvers will be considered by default

Author

Vicente Mataix Ferrandiz

Member Typedef Documentation

DenseMatrixType

typedef LocalSpaceType::MatrixType Kratos::ConditionNumberUtility::DenseMatrixType

The dense matrix.

DenseVectorType

typedef LocalSpaceType::VectorType Kratos::ConditionNumberUtility::DenseVectorType

The dense vector.

IndexType

typedef std::size_t Kratos::ConditionNumberUtility::IndexType

The index type.

LinearSolverType

typedef LinearSolver<SparseSpaceType, LocalSpaceType> Kratos::ConditionNumberUtility::LinearSolverType

The definion of the linear solver.

LocalSpaceType

typedef UblasSpace<double, Matrix, Vector> Kratos::ConditionNumberUtility::LocalSpaceType

The dense space considered.

PowerIterationEigenvalueSolverType

typedef PowerIterationEigenvalueSolver<SparseSpaceType, LocalSpaceType, LinearSolverType > Kratos::ConditionNumberUtility::PowerIterationEigenvalueSolverType

Power iteration solver for the lowest eigenvalue.

PowerIterationHighestEigenvalueSolverType

typedef PowerIterationHighestEigenvalueSolver<SparseSpaceType, LocalSpaceType, LinearSolverType > Kratos::ConditionNumberUtility::PowerIterationHighestEigenvalueSolverType

Power iteration solver for the highest eigenvalue.

ReordererType

typedef Reorderer<SparseSpaceType, LocalSpaceType > Kratos::ConditionNumberUtility::ReordererType

The reorder considered.

SizeType

typedef std::size_t Kratos::ConditionNumberUtility::SizeType

The sisze type.

SkylineLUFactorizationSolverType

typedef SkylineLUFactorizationSolver<SparseSpaceType, LocalSpaceType, ReordererType > Kratos::ConditionNumberUtility::SkylineLUFactorizationSolverType

Skyline solver definion.

SparseMatrixType

typedef SparseSpaceType::MatrixType Kratos::ConditionNumberUtility::SparseMatrixType

The compressed matrix.

SparseSpaceType

typedef UblasSpace<double, CompressedMatrix, boost::numeric::ublas::vector<double> > Kratos::ConditionNumberUtility::SparseSpaceType

The sparse space considered (the one containing the compressed matrix)

VectorType

typedef SparseSpaceType::VectorType Kratos::ConditionNumberUtility::VectorType

The vector considered.

Constructor & Destructor Documentation

ConditionNumberUtility() [1/2]

Kratos::ConditionNumberUtility::ConditionNumberUtility ( )

inline

Default constructor.

No eigen solvers provided, using the PowerIteration ones as default

ConditionNumberUtility() [2/2]

Kratos::ConditionNumberUtility::ConditionNumberUtility ( LinearSolverType::Pointer  pEigenSolverMax, LinearSolverType::Pointer  pEigenSolverMin  )

inline

Default constructor.

Parameters

pEigenSolverMax	The eigensolver used to determine the highest eigen value
pEigenSolverMin	The eigensolver used to determine the lowest eigen value

~ConditionNumberUtility()

virtual Kratos::ConditionNumberUtility::~ConditionNumberUtility ( )

inlinevirtual

Destructor.

Member Function Documentation

GetConditionNumber() [1/2]

double Kratos::ConditionNumberUtility::GetConditionNumber ( SparseMatrixType &  rInputMatrix )

inline

This function computes using the inverse power method the minimal eigenvalue.

Parameters

rInputMatrix

The matrix to compute the eigenvalue

Returns

condition_number The condition number

GetConditionNumber() [2/2]

double Kratos::ConditionNumberUtility::GetConditionNumber ( SparseMatrixType &  rInputMatrix, LinearSolverType::Pointer  pEigenSolverMax, LinearSolverType::Pointer  pEigenSolverMin  )

inline

This function computes using the inverse power method the minimal eigenvalue.

Parameters

rInputMatrix	The matrix to compute the eigenvalue
pEigenSolverMax	The solver to get the maximal eigen value
pEigenSolverMin	The solver to get the minimal eigen value

Returns

condition_number The condition number

KRATOS_CLASS_POINTER_DEFINITION()

Kratos::ConditionNumberUtility::KRATOS_CLASS_POINTER_DEFINITION

(

ConditionNumberUtility

)

Pointer definition of ConditionNumberUtility.

---

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

• /home/runner/work/Documentation/Documentation/master/kratos/utilities/condition_number_utility.h