vtkvmtkOpenNLLinearSystemSolver Class Reference

Solve a linear system of equations using open NL. More...

#include <vtkvmtkOpenNLLinearSystemSolver.h>

Inheritance diagram for vtkvmtkOpenNLLinearSystemSolver:

Collaboration diagram for vtkvmtkOpenNLLinearSystemSolver:

Public Types
enum	{ VTK_VMTK_OPENNL_SOLVER_CG, VTK_VMTK_OPENNL_SOLVER_GMRES, VTK_VMTK_OPENNL_SOLVER_BICGSTAB }
enum	{ VTK_VMTK_OPENNL_PRECONDITIONER_NONE, VTK_VMTK_OPENNL_PRECONDITIONER_JACOBI, VTK_VMTK_OPENNL_PRECONDITIONER_SSOR }
typedef vtkvmtkLinearSystemSolver	Superclass
Public Types inherited from vtkvmtkLinearSystemSolver
typedef vtkObject	Superclass

Public Member Functions
virtual int	IsA (const char *type)
vtkvmtkOpenNLLinearSystemSolver *	NewInstance () const
int	Solve () override
virtual void	SetSolverType (int)
virtual int	GetSolverType ()
void	SetSolverTypeToCG ()
void	SetSolverTypeToGMRES ()
void	SetSolverTypeToBiCGStab ()
virtual void	SetPreconditionerType (int)
virtual int	GetPreconditionerType ()
void	SetPreconditionerTypeToNone ()
void	SetPreconditionerTypeToJacobi ()
void	SetPreconditionerTypeToSSOR ()
virtual void	SetOmega (double)
virtual double	GetOmega ()
Public Member Functions inherited from vtkvmtkLinearSystemSolver
vtkvmtkLinearSystemSolver *	NewInstance () const
virtual void	SetLinearSystem (vtkvmtkLinearSystem *)
virtual vtkvmtkLinearSystem *	GetLinearSystem ()
virtual void	SetMaximumNumberOfIterations (int)
virtual int	GetMaximumNumberOfIterations ()
virtual void	SetConvergenceTolerance (double)
virtual double	GetConvergenceTolerance ()

Static Public Member Functions
static vtkvmtkOpenNLLinearSystemSolver *	New ()
static int	IsTypeOf (const char *type)
static vtkvmtkOpenNLLinearSystemSolver *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkvmtkLinearSystemSolver
static vtkvmtkLinearSystemSolver *	New ()
static int	IsTypeOf (const char *type)
static vtkvmtkLinearSystemSolver *	SafeDownCast (vtkObjectBase *o)

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkvmtkOpenNLLinearSystemSolver ()
	~vtkvmtkOpenNLLinearSystemSolver ()
Protected Member Functions inherited from vtkvmtkLinearSystemSolver
	vtkvmtkLinearSystemSolver ()
	~vtkvmtkLinearSystemSolver ()

Protected Attributes
int	SolverType
int	PreconditionerType
double	Omega
Protected Attributes inherited from vtkvmtkLinearSystemSolver
vtkvmtkLinearSystem *	LinearSystem
int	MaximumNumberOfIterations
double	ConvergenceTolerance
int	NumberOfIterations
double	Residual

Detailed Description

Solve a linear system of equations using open NL.

Date

2006/04/06 16:46:43

Revision

1.3

There are a number of different solver types that can be used:

• VTK_VMTK_OPENNL_SOLVER_BICGSTAB = Biconjugate gradient stabilized method
• VTK_VMTK_OPENNL_SOLVER_GMRES = Generalized minimal residual method
• VTK_VMTK_OPENNL_SOLVER_CG = Iterative conjugate gradient solver

Definition at line 38 of file vtkvmtkOpenNLLinearSystemSolver.h.

Member Typedef Documentation

Superclass

typedef vtkvmtkLinearSystemSolver vtkvmtkOpenNLLinearSystemSolver::Superclass

Definition at line 42 of file vtkvmtkOpenNLLinearSystemSolver.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
VTK_VMTK_OPENNL_SOLVER_CG
VTK_VMTK_OPENNL_SOLVER_GMRES
VTK_VMTK_OPENNL_SOLVER_BICGSTAB

Definition at line 68 of file vtkvmtkOpenNLLinearSystemSolver.h.

    {
      VTK_VMTK_OPENNL_SOLVER_CG,
      VTK_VMTK_OPENNL_SOLVER_GMRES,
      VTK_VMTK_OPENNL_SOLVER_BICGSTAB
    };

anonymous enum

anonymous enum

Enumerator
VTK_VMTK_OPENNL_PRECONDITIONER_NONE
VTK_VMTK_OPENNL_PRECONDITIONER_JACOBI
VTK_VMTK_OPENNL_PRECONDITIONER_SSOR

Definition at line 77 of file vtkvmtkOpenNLLinearSystemSolver.h.

    {
      VTK_VMTK_OPENNL_PRECONDITIONER_NONE,
      VTK_VMTK_OPENNL_PRECONDITIONER_JACOBI,
      VTK_VMTK_OPENNL_PRECONDITIONER_SSOR
    };

Constructor & Destructor Documentation

vtkvmtkOpenNLLinearSystemSolver()

vtkvmtkOpenNLLinearSystemSolver::vtkvmtkOpenNLLinearSystemSolver ( )

protected

~vtkvmtkOpenNLLinearSystemSolver()

vtkvmtkOpenNLLinearSystemSolver::~vtkvmtkOpenNLLinearSystemSolver ( )

inlineprotected

Definition at line 87 of file vtkvmtkOpenNLLinearSystemSolver.h.

{};

Member Function Documentation

New()

static vtkvmtkOpenNLLinearSystemSolver* vtkvmtkOpenNLLinearSystemSolver::New ( )

static

IsTypeOf()

static int vtkvmtkOpenNLLinearSystemSolver::IsTypeOf ( const char *  type )

static

IsA()

virtual int vtkvmtkOpenNLLinearSystemSolver::IsA ( const char *  type )

virtual

Reimplemented from vtkvmtkLinearSystemSolver.

SafeDownCast()

static vtkvmtkOpenNLLinearSystemSolver* vtkvmtkOpenNLLinearSystemSolver::SafeDownCast ( vtkObjectBase *  o )

static

NewInstanceInternal()

virtual vtkObjectBase* vtkvmtkOpenNLLinearSystemSolver::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkvmtkLinearSystemSolver.

NewInstance()

vtkvmtkOpenNLLinearSystemSolver* vtkvmtkOpenNLLinearSystemSolver::NewInstance

(

)

const

Solve()

int vtkvmtkOpenNLLinearSystemSolver::Solve ( )

overridevirtual

Reimplemented from vtkvmtkLinearSystemSolver.

SetSolverType()

virtual void vtkvmtkOpenNLLinearSystemSolver::SetSolverType ( int  )

virtual

GetSolverType()

virtual int vtkvmtkOpenNLLinearSystemSolver::GetSolverType ( )

virtual

SetSolverTypeToCG()

void vtkvmtkOpenNLLinearSystemSolver::SetSolverTypeToCG ( )

inline

Definition at line 48 of file vtkvmtkOpenNLLinearSystemSolver.h.

    { this->SetSolverType(VTK_VMTK_OPENNL_SOLVER_CG); }

SetSolverTypeToGMRES()

void vtkvmtkOpenNLLinearSystemSolver::SetSolverTypeToGMRES ( )

inline

Definition at line 50 of file vtkvmtkOpenNLLinearSystemSolver.h.

    { this->SetSolverType(VTK_VMTK_OPENNL_SOLVER_GMRES); }

SetSolverTypeToBiCGStab()

void vtkvmtkOpenNLLinearSystemSolver::SetSolverTypeToBiCGStab ( )

inline

Definition at line 52 of file vtkvmtkOpenNLLinearSystemSolver.h.

    { this->SetSolverType(VTK_VMTK_OPENNL_SOLVER_BICGSTAB); }

SetPreconditionerType()

virtual void vtkvmtkOpenNLLinearSystemSolver::SetPreconditionerType ( int  )

virtual

GetPreconditionerType()

virtual int vtkvmtkOpenNLLinearSystemSolver::GetPreconditionerType ( )

virtual

SetPreconditionerTypeToNone()

void vtkvmtkOpenNLLinearSystemSolver::SetPreconditionerTypeToNone ( )

inline

Definition at line 57 of file vtkvmtkOpenNLLinearSystemSolver.h.

    { this->SetPreconditionerType(VTK_VMTK_OPENNL_PRECONDITIONER_NONE); }

SetPreconditionerTypeToJacobi()

void vtkvmtkOpenNLLinearSystemSolver::SetPreconditionerTypeToJacobi ( )

inline

Definition at line 59 of file vtkvmtkOpenNLLinearSystemSolver.h.

    { this->SetPreconditionerType(VTK_VMTK_OPENNL_PRECONDITIONER_JACOBI); }

SetPreconditionerTypeToSSOR()

void vtkvmtkOpenNLLinearSystemSolver::SetPreconditionerTypeToSSOR ( )

inline

Definition at line 61 of file vtkvmtkOpenNLLinearSystemSolver.h.

    { this->SetPreconditionerType(VTK_VMTK_OPENNL_PRECONDITIONER_SSOR); }

SetOmega()

virtual void vtkvmtkOpenNLLinearSystemSolver::SetOmega ( double  )

virtual

GetOmega()

virtual double vtkvmtkOpenNLLinearSystemSolver::GetOmega ( )

virtual

Member Data Documentation

SolverType

int vtkvmtkOpenNLLinearSystemSolver::SolverType

protected

Definition at line 87 of file vtkvmtkOpenNLLinearSystemSolver.h.

PreconditionerType

int vtkvmtkOpenNLLinearSystemSolver::PreconditionerType

protected

Definition at line 90 of file vtkvmtkOpenNLLinearSystemSolver.h.

Omega

double vtkvmtkOpenNLLinearSystemSolver::Omega

protected

Definition at line 91 of file vtkvmtkOpenNLLinearSystemSolver.h.

---

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

• vtkvmtkOpenNLLinearSystemSolver.h