oofem::VoidPreconditioner Class Reference

#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.
	VoidPreconditioner ()
	Constructor. The user should call initializeFrom and init services in this given order to ensure consistency.
virtual	~VoidPreconditioner (void)
	Destructor.
void	init (const SparseMtrx &a) override
void	solve (const FloatArray &rhs, FloatArray &solution) const override
void	trans_solve (const FloatArray &rhs, FloatArray &solution) const override
const char *	giveClassName () const override
	Returns the preconditioner name.
Public Member Functions inherited from oofem::Preconditioner
	Preconditioner (const SparseMtrx &a, InputRecord &attributes)
	Preconditioner ()
virtual	~Preconditioner (void)
	Destructor.
FloatArray	solve (const FloatArray &rhs) const
FloatArray	trans_solve (const FloatArray &rhs) const
virtual void	initializeFrom (InputRecord &ir)
	Initializes receiver from given record. Empty implementation.

Detailed Description

Class implementing void preconditioner.

Definition at line 46 of file voidprecond.h.

Constructor & Destructor Documentation

VoidPreconditioner() [1/2]

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

Constructor. Creates the empty preconditioner.

Definition at line 40 of file voidprecond.C.

References oofem::Preconditioner::Preconditioner().

VoidPreconditioner() [2/2]

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.

References oofem::Preconditioner::Preconditioner().

~VoidPreconditioner()

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

inlinevirtual

Destructor.

Definition at line 54 of file voidprecond.h.

Member Function Documentation

giveClassName()

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

inlineoverridevirtual

Returns the preconditioner name.

Reimplemented from oofem::Preconditioner.

Definition at line 60 of file voidprecond.h.

init()

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

inlineoverridevirtual

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 56 of file voidprecond.h.

solve()

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

inlineoverridevirtual

Solves the linear system.

Parameters

rhs	Right hand side.
solution	Solution.

Implements oofem::Preconditioner.

Definition at line 57 of file voidprecond.h.

trans_solve()

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

inlineoverridevirtual

Solves the transposed system.

Parameters

rhs	Right hand side.
solution	Solution.

Implements oofem::Preconditioner.

Definition at line 58 of file voidprecond.h.

---

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

• voidprecond.h
• voidprecond.C