OpenVDB: Preconditioner< T > Class Template Reference

OpenVDB 6.1.0

Public Types | Public Member Functions | List of all members
Preconditioner< T > 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 T>
class openvdb::v6_1::math::pcg::Preconditioner< T >

Base class for conjugate gradient preconditioners.

## Member Typedef Documentation

## ◆ Ptr

using Ptr = SharedPtr<Preconditioner>

## ◆ ValueType

using ValueType = T

## Constructor & Destructor Documentation

## ◆ Preconditioner()

Preconditioner | ( | const SparseStencilMatrix< T, STENCIL_SIZE > & |  | ) |
| inline

## ◆ ~Preconditioner()

virtual ~Preconditioner | ( |  | ) |
| virtualdefault

## Member Function Documentation

## ◆ apply()

virtual void apply | ( | const Vector< T > & | r,
|  | Vector< T > & | z
| ) |  |
| pure virtual

Apply this preconditioner to a residue vector: z = M−1r

Parameters

  | r | residue vector
  [out] | z | preconditioned residue vector

Implemented in IncompleteCholeskyPreconditioner< MatrixType >, and JacobiPreconditioner< MatrixType >.

## ◆ isValid()

virtual bool isValid | ( |  | ) | const
| inlinevirtual

Reimplemented in IncompleteCholeskyPreconditioner< MatrixType >.

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

- ConjGradient.h