OOFEM  2.4
OOFEM.org - Object Oriented Finite Element Solver
oofem::CompCol_ICPreconditioner Class Reference

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

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

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

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.

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.

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

Destructor.

Definition at line 59 of file icprecond.h.

Member Function Documentation

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

Returns the preconditioner name.

Reimplemented from oofem::Preconditioner.

Definition at line 68 of file icprecond.h.

void oofem::CompCol_ICPreconditioner::ICFactor ( )
protected

Definition at line 129 of file icprecond.C.

References oofem::IntArray::giveSize(), indx_, pntr_, and val_.

Referenced by initialize().

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

Definition at line 163 of file icprecond.C.

References oofem::FloatArray::giveSize(), indx_, pntr_, val_, and oofem::FloatArray::zero().

Referenced by solve(), and trans_solve().

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

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
aSparse matrix to be preconditioned.

Reimplemented from oofem::Preconditioner.

Definition at line 49 of file icprecond.C.

References initialize(), and OOFEM_ERROR.

void oofem::CompCol_ICPreconditioner::initialize ( const CompCol A)
IRResultType oofem::CompCol_ICPreconditioner::initializeFrom ( InputRecord ir)
virtual

Initializes receiver from given record. Empty implementation.

Reimplemented from oofem::Preconditioner.

Definition at line 43 of file icprecond.C.

References oofem::Preconditioner::initializeFrom().

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

Definition at line 192 of file icprecond.C.

References qsortRowPartition().

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

Definition at line 205 of file icprecond.C.

Referenced by qsortRow().

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

Solves the linear system.

Parameters
rhsRight hand side.
solutionSolution.

Implements oofem::Preconditioner.

Definition at line 113 of file icprecond.C.

References ICSolve().

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

Solves the transposed system.

Parameters
rhsRight hand side.
solutionSolution.

Implements oofem::Preconditioner.

Definition at line 121 of file icprecond.C.

References ICSolve().

Member Data Documentation

int oofem::CompCol_ICPreconditioner::dim_[2]
private

Definition at line 51 of file icprecond.h.

Referenced by initialize().

IntArray oofem::CompCol_ICPreconditioner::indx_
private

Definition at line 49 of file icprecond.h.

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

int oofem::CompCol_ICPreconditioner::nz_
private

Definition at line 50 of file icprecond.h.

Referenced by initialize().

IntArray oofem::CompCol_ICPreconditioner::pntr_
private

Definition at line 48 of file icprecond.h.

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

FloatArray oofem::CompCol_ICPreconditioner::val_
private

Definition at line 47 of file icprecond.h.

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


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

This page is part of the OOFEM documentation. Copyright (c) 2011 Borek Patzak
Project e-mail: info@oofem.org
Generated at Tue Jan 2 2018 20:07:34 for OOFEM by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2011