oofem::CompCol_ICPreconditioner Class Reference

#include <icprecond.h>

Inheritance diagram for oofem::CompCol_ICPreconditioner:

Collaboration diagram for oofem::CompCol_ICPreconditioner:

Public Member Functions
	CompCol_ICPreconditioner (const SparseMtrx &A, InputRecord &attributes)
	Constructor. Initializes the the receiver (constructs the precontioning matrix M) of given matrix.
	CompCol_ICPreconditioner ()
	Constructor. The user should call initializeFrom and init services in this given order to ensure consistency.
virtual	~CompCol_ICPreconditioner (void)
	Destructor.
void	init (const SparseMtrx &a) override
void	initialize (const CompCol &A)
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.
void	initializeFrom (InputRecord &ir) override
	Initializes receiver from given record. Empty implementation.
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

Protected Member Functions
void	qsortRow (IntArray &, FloatArray &, int l, int r)
int	qsortRowPartition (IntArray &, FloatArray &, int l, int r)
void	ICSolve (FloatArray &dest) const
void	ICFactor ()

Private Attributes
FloatArray	val
IntArray	pntr
IntArray	indx
int	nz
int	dim [2]

Detailed Description

Incomplete Cholesky IC(0) (no fill - up) preconditioner for symmetric, positive definite matrices.

Definition at line 44 of file icprecond.h.

Constructor & Destructor Documentation

CompCol_ICPreconditioner() [1/2]

oofem::CompCol_ICPreconditioner::CompCol_ICPreconditioner	(	const SparseMtrx &	A,
		InputRecord &	attributes )

Constructor. Initializes the the receiver (constructs the precontioning matrix M) of given matrix.

Definition at line 38 of file icprecond.C.

References oofem::Preconditioner::Preconditioner().

CompCol_ICPreconditioner() [2/2]

oofem::CompCol_ICPreconditioner::CompCol_ICPreconditioner ( )

inline

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

Definition at line 57 of file icprecond.h.

References oofem::Preconditioner::Preconditioner().

~CompCol_ICPreconditioner()

virtual oofem::CompCol_ICPreconditioner::~CompCol_ICPreconditioner ( void )

inlinevirtual

Destructor.

Definition at line 59 of file icprecond.h.

Member Function Documentation

giveClassName()

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

inlineoverridevirtual

Returns the preconditioner name.

Reimplemented from oofem::Preconditioner.

Definition at line 68 of file icprecond.h.

ICFactor()

void oofem::CompCol_ICPreconditioner::ICFactor ( )

protected

Definition at line 123 of file icprecond.C.

References indx, pntr, and val.

Referenced by initialize().

ICSolve()

void oofem::CompCol_ICPreconditioner::ICSolve ( FloatArray & dest ) const

protected

Definition at line 156 of file icprecond.C.

References oofem::FloatArray::giveSize(), indx, pntr, val, and oofem::FloatArray::zero().

Referenced by solve(), and trans_solve().

init()

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

overridevirtual

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 51 of file icprecond.C.

References initialize(), and OOFEM_ERROR.

initialize()

void oofem::CompCol_ICPreconditioner::initialize

(

const CompCol &

A

)

Definition at line 64 of file icprecond.C.

References oofem::CompCol::col_ptr(), dim, oofem::SparseMtrx::giveNumberOfColumns(), oofem::SparseMtrx::giveNumberOfRows(), ICFactor(), indx, nz, OOFEM_ERROR, pntr, oofem::CompCol::row_ind(), val, and oofem::CompCol::values().

Referenced by init().

initializeFrom()

void oofem::CompCol_ICPreconditioner::initializeFrom ( InputRecord & ir )

overridevirtual

Initializes receiver from given record. Empty implementation.

Reimplemented from oofem::Preconditioner.

Definition at line 44 of file icprecond.C.

qsortRow()

void oofem::CompCol_ICPreconditioner::qsortRow ( IntArray & src, FloatArray & val, int l, int r )

protected

Definition at line 184 of file icprecond.C.

References qsortRow(), qsortRowPartition(), and val.

Referenced by qsortRow().

qsortRowPartition()

int oofem::CompCol_ICPreconditioner::qsortRowPartition ( IntArray & src, FloatArray & val, int l, int r )

protected

Definition at line 197 of file icprecond.C.

References val.

Referenced by qsortRow().

solve()

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

overridevirtual

Solves the linear system.

Parameters

rhs	Right hand side.
solution	Solution.

Implements oofem::Preconditioner.

Definition at line 107 of file icprecond.C.

References ICSolve().

trans_solve()

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

overridevirtual

Solves the transposed system.

Parameters

rhs	Right hand side.
solution	Solution.

Implements oofem::Preconditioner.

Definition at line 115 of file icprecond.C.

References ICSolve().

Member Data Documentation

dim

int oofem::CompCol_ICPreconditioner::dim[2]

private

Definition at line 51 of file icprecond.h.

Referenced by initialize().

indx

IntArray oofem::CompCol_ICPreconditioner::indx

private

Definition at line 49 of file icprecond.h.

Referenced by ICFactor(), ICSolve(), and initialize().

nz

int oofem::CompCol_ICPreconditioner::nz

private

Definition at line 50 of file icprecond.h.

Referenced by initialize().

pntr

IntArray oofem::CompCol_ICPreconditioner::pntr

private

Definition at line 48 of file icprecond.h.

Referenced by ICFactor(), ICSolve(), and initialize().

val

FloatArray oofem::CompCol_ICPreconditioner::val

private

Definition at line 47 of file icprecond.h.

Referenced by ICFactor(), ICSolve(), initialize(), qsortRow(), and qsortRowPartition().

---

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

• icprecond.h
• icprecond.C