openvdb::OPENVDB_VERSION_NAME::math::pcg::Preconditioner< ValueType > Class Template Reference

Base class for conjugate gradient preconditioners. More...

#include <ConjGradient.h>

Public Types
using	ValueType = T
using	Ptr = SharedPtr< Preconditioner >

Public Member Functions
template<SizeType STENCIL_SIZE>
	Preconditioner (const SparseStencilMatrix< T, STENCIL_SIZE > &)
virtual	~Preconditioner ()=default
virtual bool	isValid () const
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 ValueType>
class openvdb::OPENVDB_VERSION_NAME::math::pcg::Preconditioner< ValueType >

Base class for conjugate gradient preconditioners.

Definition at line 41 of file ConjGradient.h.

Member Typedef Documentation

template<typename ValueType>

using openvdb::OPENVDB_VERSION_NAME::math::pcg::Preconditioner< ValueType >::Ptr = SharedPtr<Preconditioner>

Definition at line 468 of file ConjGradient.h.

template<typename ValueType>

using openvdb::OPENVDB_VERSION_NAME::math::pcg::Preconditioner< ValueType >::ValueType = T

Definition at line 467 of file ConjGradient.h.

Constructor & Destructor Documentation

template<typename ValueType>

template<SizeType STENCIL_SIZE>

openvdb::OPENVDB_VERSION_NAME::math::pcg::Preconditioner< ValueType >::Preconditioner ( const SparseStencilMatrix< T, STENCIL_SIZE > &  )

inline

Definition at line 470 of file ConjGradient.h.

template<typename ValueType>

virtual openvdb::OPENVDB_VERSION_NAME::math::pcg::Preconditioner< ValueType >::~Preconditioner ( )

virtualdefault

Member Function Documentation

template<typename ValueType>

virtual void openvdb::OPENVDB_VERSION_NAME::math::pcg::Preconditioner< ValueType >::apply ( const Vector< T > &  r, Vector< T > &  z  )

pure virtual

Apply this preconditioner to a residue vector: z = M⁻¹r

Parameters

	r	residue vector
[out]	z	preconditioned residue vector

template<typename ValueType>

virtual bool openvdb::OPENVDB_VERSION_NAME::math::pcg::Preconditioner< ValueType >::isValid ( ) const

inlinevirtual

Reimplemented in openvdb::OPENVDB_VERSION_NAME::math::pcg::IncompleteCholeskyPreconditioner< MatrixType >.

Definition at line 473 of file ConjGradient.h.

---

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

• openvdb/math/ConjGradient.h