openvdb::OPENVDB_VERSION_NAME::math::pcg::IncompleteCholeskyPreconditioner< MatrixType > Class Template Reference

Preconditioner using incomplete Cholesky factorization. More...

#include <ConjGradient.h>

Inheritance diagram for openvdb::OPENVDB_VERSION_NAME::math::pcg::IncompleteCholeskyPreconditioner< MatrixType >:

Public Types
using	ValueType = typename MatrixType::ValueType
using	BaseType = Preconditioner< ValueType >
using	VectorType = Vector< ValueType >
using	Ptr = SharedPtr< IncompleteCholeskyPreconditioner >
using	TriangularMatrix = SparseStencilMatrix< ValueType, 4 >
using	TriangleConstRow = typename TriangularMatrix::ConstRow
using	TriangleRowEditor = typename TriangularMatrix::RowEditor
Public Types inherited from openvdb::OPENVDB_VERSION_NAME::math::pcg::Preconditioner< MatrixType::ValueType >
using	ValueType = T
using	Ptr = SharedPtr< Preconditioner >

Public Member Functions
	IncompleteCholeskyPreconditioner (const MatrixType &matrix)
	~IncompleteCholeskyPreconditioner () override=default
bool	isValid () const override
void	apply (const Vector< ValueType > &rVec, Vector< ValueType > &zVec) override
const TriangularMatrix &	lowerMatrix () const
const TriangularMatrix &	upperMatrix () const
Public Member Functions inherited from openvdb::OPENVDB_VERSION_NAME::math::pcg::Preconditioner< MatrixType::ValueType >
	Preconditioner (const SparseStencilMatrix< T, STENCIL_SIZE > &)
virtual	~Preconditioner ()=default
virtual void	apply (const Vector< T > &r, Vector< T > &z)=0
	Apply this preconditioner to a residue vector: z = M−1r More...

Detailed Description

template<typename MatrixType>
class openvdb::OPENVDB_VERSION_NAME::math::pcg::IncompleteCholeskyPreconditioner< MatrixType >

Preconditioner using incomplete Cholesky factorization.

Definition at line 43 of file ConjGradient.h.

Member Typedef Documentation

template<typename MatrixType >

using openvdb::OPENVDB_VERSION_NAME::math::pcg::IncompleteCholeskyPreconditioner< MatrixType >::BaseType = Preconditioner<ValueType>

Definition at line 1354 of file ConjGradient.h.

template<typename MatrixType >

using openvdb::OPENVDB_VERSION_NAME::math::pcg::IncompleteCholeskyPreconditioner< MatrixType >::Ptr = SharedPtr<IncompleteCholeskyPreconditioner>

Definition at line 1356 of file ConjGradient.h.

template<typename MatrixType >

using openvdb::OPENVDB_VERSION_NAME::math::pcg::IncompleteCholeskyPreconditioner< MatrixType >::TriangleConstRow = typename TriangularMatrix::ConstRow

Definition at line 1358 of file ConjGradient.h.

template<typename MatrixType >

using openvdb::OPENVDB_VERSION_NAME::math::pcg::IncompleteCholeskyPreconditioner< MatrixType >::TriangleRowEditor = typename TriangularMatrix::RowEditor

Definition at line 1359 of file ConjGradient.h.

template<typename MatrixType >

using openvdb::OPENVDB_VERSION_NAME::math::pcg::IncompleteCholeskyPreconditioner< MatrixType >::TriangularMatrix = SparseStencilMatrix<ValueType, 4>

Definition at line 1357 of file ConjGradient.h.

template<typename MatrixType >

using openvdb::OPENVDB_VERSION_NAME::math::pcg::IncompleteCholeskyPreconditioner< MatrixType >::ValueType = typename MatrixType::ValueType

Definition at line 1353 of file ConjGradient.h.

template<typename MatrixType >

using openvdb::OPENVDB_VERSION_NAME::math::pcg::IncompleteCholeskyPreconditioner< MatrixType >::VectorType = Vector<ValueType>

Definition at line 1355 of file ConjGradient.h.

Constructor & Destructor Documentation

template<typename MatrixType >

openvdb::OPENVDB_VERSION_NAME::math::pcg::IncompleteCholeskyPreconditioner< MatrixType >::IncompleteCholeskyPreconditioner ( const MatrixType &  matrix )

inline

Definition at line 1361 of file ConjGradient.h.

template<typename MatrixType >

openvdb::OPENVDB_VERSION_NAME::math::pcg::IncompleteCholeskyPreconditioner< MatrixType >::~IncompleteCholeskyPreconditioner ( )

overridedefault

Member Function Documentation

template<typename MatrixType >

void openvdb::OPENVDB_VERSION_NAME::math::pcg::IncompleteCholeskyPreconditioner< MatrixType >::apply ( const Vector< ValueType > &  rVec, Vector< ValueType > &  zVec  )

inlineoverride

Definition at line 1458 of file ConjGradient.h.

template<typename MatrixType >

bool openvdb::OPENVDB_VERSION_NAME::math::pcg::IncompleteCholeskyPreconditioner< MatrixType >::isValid ( ) const

inlineoverridevirtual

Reimplemented from openvdb::OPENVDB_VERSION_NAME::math::pcg::Preconditioner< MatrixType::ValueType >.

Definition at line 1456 of file ConjGradient.h.

template<typename MatrixType >

const TriangularMatrix& openvdb::OPENVDB_VERSION_NAME::math::pcg::IncompleteCholeskyPreconditioner< MatrixType >::lowerMatrix ( ) const

inline

Definition at line 1506 of file ConjGradient.h.

template<typename MatrixType >

const TriangularMatrix& openvdb::OPENVDB_VERSION_NAME::math::pcg::IncompleteCholeskyPreconditioner< MatrixType >::upperMatrix ( ) const

inline

Definition at line 1507 of file ConjGradient.h.

---

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

• openvdb/math/ConjGradient.h