OpenVDB  3.1.0
Classes | Public Types | Public Member Functions | List of all members
JacobiPreconditioner< MatrixType > Class Template Reference

Diagonal preconditioner. More...

#include <ConjGradient.h>

Inherits Preconditioner< MatrixType::ValueType >.

Public Types

typedef MatrixType::ValueType ValueType
 
typedef Preconditioner< ValueTypeBaseType
 
typedef Vector< ValueTypeVectorType
 
typedef boost::shared_ptr< JacobiPreconditionerPtr
 

Public Member Functions

 JacobiPreconditioner (const MatrixType &A)
 
virtual ~JacobiPreconditioner ()
 
virtual void apply (const Vector< ValueType > &r, Vector< ValueType > &z)
 Apply this preconditioner to a residue vector: z = M−1r More...
 
bool isFinite () const
 Return true if all values along the diagonal are finite. More...
 
virtual bool isValid () const
 

Detailed Description

template<typename MatrixType>
class openvdb::v3_1_0::math::pcg::JacobiPreconditioner< MatrixType >

Diagonal preconditioner.

Member Typedef Documentation

typedef boost::shared_ptr<JacobiPreconditioner> Ptr
typedef MatrixType::ValueType ValueType

Constructor & Destructor Documentation

JacobiPreconditioner ( const MatrixType &  A)
inline
virtual ~JacobiPreconditioner ( )
inlinevirtual

Member Function Documentation

virtual void apply ( const Vector< ValueType > &  r,
Vector< ValueType > &  z 
)
inlinevirtual

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

Parameters
rresidue vector
[out]zpreconditioned residue vector

Implements Preconditioner< MatrixType::ValueType >.

bool isFinite ( ) const
inline

Return true if all values along the diagonal are finite.

virtual bool isValid ( ) const
inlinevirtualinherited

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