oofem::VoidPreconditioner Class Reference

Class implementing void preconditioner. More...

#include <voidprecond.h>

Inheritance diagram for oofem::VoidPreconditioner:

Collaboration diagram for oofem::VoidPreconditioner:

Public Member Functions
	VoidPreconditioner (const SparseMtrx &a, InputRecord &attributes)
	Constructor. Creates the empty preconditioner. More...
	VoidPreconditioner ()
	Constructor. The user should call initializeFrom and init services in this given order to ensure consistency. More...
virtual	~VoidPreconditioner (void)
	Destructor. More...
void	init (const SparseMtrx &a)
	Initializes the receiver (constructs the preconditioning matrix M) of given matrix. More...
void	solve (const FloatArray &rhs, FloatArray &solution) const
	Solves the linear system. More...
void	trans_solve (const FloatArray &rhs, FloatArray &solution) const
	Solves the transposed system. More...
virtual const char *	giveClassName () const
	Returns the preconditioner name. More...
Public Member Functions inherited from oofem::Preconditioner
	Preconditioner (const SparseMtrx &a, InputRecord &attributes)
	Constructor. More...
	Preconditioner ()
	Constructor. More...
virtual	~Preconditioner (void)
	Destructor. More...
FloatArray	solve (const FloatArray &rhs) const
	Solves the linear system. More...
FloatArray	trans_solve (const FloatArray &rhs) const
	Solves transposed system. More...
virtual IRResultType	initializeFrom (InputRecord *ir)
	Initializes receiver from given record. Empty implementation. More...

Detailed Description

Class implementing void preconditioner.

Definition at line 46 of file voidprecond.h.

Constructor & Destructor Documentation

oofem::VoidPreconditioner::VoidPreconditioner	(	const SparseMtrx &	a,
		InputRecord &	attributes
	)

Constructor. Creates the empty preconditioner.

Definition at line 40 of file voidprecond.C.

oofem::VoidPreconditioner::VoidPreconditioner

(

)

Constructor. The user should call initializeFrom and init services in this given order to ensure consistency.

Definition at line 43 of file voidprecond.C.

virtual oofem::VoidPreconditioner::~VoidPreconditioner ( void  )

inlinevirtual

Destructor.

Definition at line 56 of file voidprecond.h.

Member Function Documentation

virtual const char* oofem::VoidPreconditioner::giveClassName ( ) const

inlinevirtual

Returns the preconditioner name.

Reimplemented from oofem::Preconditioner.

Definition at line 62 of file voidprecond.h.

void oofem::VoidPreconditioner::init ( const SparseMtrx &  a )

inlinevirtual

Initializes the receiver (constructs the preconditioning matrix M) of given matrix.

Virtual service, to be implemented by derived classes. Should be called after initializeFrom service.

Parameters

a	Sparse matrix to be preconditioned.

Reimplemented from oofem::Preconditioner.

Definition at line 58 of file voidprecond.h.

void oofem::VoidPreconditioner::solve ( const FloatArray &  rhs, FloatArray &  solution  ) const

inlinevirtual

Solves the linear system.

Parameters

rhs	Right hand side.
solution	Solution.

Implements oofem::Preconditioner.

Definition at line 59 of file voidprecond.h.

void oofem::VoidPreconditioner::trans_solve ( const FloatArray &  rhs, FloatArray &  solution  ) const

inlinevirtual

Solves the transposed system.

Parameters

rhs	Right hand side.
solution	Solution.

Implements oofem::Preconditioner.

Definition at line 60 of file voidprecond.h.

---

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

• voidprecond.h
• voidprecond.C