HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
openvdb::OPENVDB_VERSION_NAME::math::pcg::Preconditioner< ValueType > Class Template Referenceabstract

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 68 of file ConjGradient.h.

Member Typedef Documentation

Definition at line 495 of file ConjGradient.h.

Definition at line 494 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 497 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−1r

Parameters
rresidue vector
[out]zpreconditioned residue vector
template<typename ValueType>
virtual bool openvdb::OPENVDB_VERSION_NAME::math::pcg::Preconditioner< ValueType >::isValid ( void  ) const
inlinevirtual

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