Ifpack_OverlapFactorObject Class Reference

Ifpack_OverlapFactorObject: Supports functionality common to Ifpack overlap factorization classes. More...

#include <Ifpack_OverlapFactorObject.h>

Inheritance diagram for Ifpack_OverlapFactorObject:

[legend]
List of all members.

Constructors/Destructor

 Ifpack_OverlapFactorObject (const Ifpack_OverlapGraph *OverlapGraph)
 Constructor using Ifpack_OverlapGraph.
 Ifpack_OverlapFactorObject (const Epetra_RowMatrix *UserMatrix)
 Constructor using Epetra_RowMatrix.
 Ifpack_OverlapFactorObject (const Ifpack_OverlapFactorObject &Source)
 Copy constructor.
virtual ~Ifpack_OverlapFactorObject ()
 Ifpack_OverlapFactorObject Destructor.

Initialization methods.

virtual int InitValues (const Epetra_RowMatrix *UserMatrix)
 Initialize values from user matrix A, can be called repeatedly as matrix values change.
virtual int Factor ()
 Compute factors.

Attribue accessor methods.

bool Allocated () const
 If storage has been allocated, this query returns true, otherwise it returns false.
bool ValuesInitialized () const
 If values have been initialized, this query returns true, otherwise it returns false.
bool Factored () const
 If factor is completed, this query returns true, otherwise it returns false.

Methods that must be implemented by derived classes.

virtual int ProcessOverlapMatrix (const Epetra_RowMatrix &A)=0
 Virtual method that processes the overlap matrix as needed by the derived class.
virtual int DerivedFactor ()=0
 Virtual method that computes the factors as needed by the derived class.

Protected Member Functions

void SetAllocated (bool Flag)
void SetFactored (bool Flag)
void SetValuesInitialized (bool Flag)

Protected Attributes

bool Factored_
bool Allocated_
bool ValuesInitialized_
Ifpack_OverlapGraphOverlapGraph_
Epetra_RowMatrixUserMatrix_

Detailed Description

Ifpack_OverlapFactorObject: Supports functionality common to Ifpack overlap factorization classes.

Definition at line 35 of file Ifpack_OverlapFactorObject.h.


Constructor & Destructor Documentation

Ifpack_OverlapFactorObject::Ifpack_OverlapFactorObject const Ifpack_OverlapGraph OverlapGraph  ) 
 

Constructor using Ifpack_OverlapGraph.

Creates an object from the overlap graph.

Parameters:
In OverlapGraph - Graph describing the graph that should be used for the factors.

Ifpack_OverlapFactorObject::Ifpack_OverlapFactorObject const Epetra_RowMatrix UserMatrix  ) 
 

Constructor using Epetra_RowMatrix.

Creates an Ifpack_Graph object from the user graph implicitly defined by the Epetra_RowMatrix interface.

Parameters:
In RowMatrix - An object that has implemented the Epetra_RowMatrix interface.

Ifpack_OverlapFactorObject::Ifpack_OverlapFactorObject const Ifpack_OverlapFactorObject Source  ) 
 

Copy constructor.

virtual Ifpack_OverlapFactorObject::~Ifpack_OverlapFactorObject  )  [virtual]
 

Ifpack_OverlapFactorObject Destructor.


Member Function Documentation

virtual int Ifpack_OverlapFactorObject::InitValues const Epetra_RowMatrix UserMatrix  )  [virtual]
 

Initialize values from user matrix A, can be called repeatedly as matrix values change.

Processes matrix values, primarily handling overlap if any has been requested. This method then calls ProcessOverlapMatrix(), a virtual method that must be implemented by any class that derives from this class.

Parameters:
In UserMatrix - User matrix to be processed.

virtual int Ifpack_OverlapFactorObject::Factor  )  [virtual]
 

Compute factors.

This function computes factors using the method DerivedFactor() that is implemented by the derived class. InitValues() must be called before the factorization can proceed.

bool Ifpack_OverlapFactorObject::Allocated  )  const [inline]
 

If storage has been allocated, this query returns true, otherwise it returns false.

Definition at line 84 of file Ifpack_OverlapFactorObject.h.

bool Ifpack_OverlapFactorObject::ValuesInitialized  )  const [inline]
 

If values have been initialized, this query returns true, otherwise it returns false.

Definition at line 87 of file Ifpack_OverlapFactorObject.h.

bool Ifpack_OverlapFactorObject::Factored  )  const [inline]
 

If factor is completed, this query returns true, otherwise it returns false.

Definition at line 90 of file Ifpack_OverlapFactorObject.h.

virtual int Ifpack_OverlapFactorObject::ProcessOverlapMatrix const Epetra_RowMatrix A  )  [protected, pure virtual]
 

Virtual method that processes the overlap matrix as needed by the derived class.

This method is called by InitValues() afer the user matrix has been distributed to support overlap (if any overlap is requested). ProcessOverlapMatrix must be implemented by any derived class of Ifpack_OverlapFactorObject.

Implemented in Ifpack_CrsIlut.

virtual int Ifpack_OverlapFactorObject::DerivedFactor  )  [protected, pure virtual]
 

Virtual method that computes the factors as needed by the derived class.

This method is called by Factor() afer some safety checks have been performed.

Implemented in Ifpack_CrsIlut.

void Ifpack_OverlapFactorObject::SetAllocated bool  Flag  )  [inline, protected]
 

Definition at line 109 of file Ifpack_OverlapFactorObject.h.

void Ifpack_OverlapFactorObject::SetFactored bool  Flag  )  [inline, protected]
 

Definition at line 110 of file Ifpack_OverlapFactorObject.h.

void Ifpack_OverlapFactorObject::SetValuesInitialized bool  Flag  )  [inline, protected]
 

Definition at line 111 of file Ifpack_OverlapFactorObject.h.


Member Data Documentation

bool Ifpack_OverlapFactorObject::Factored_ [protected]
 

Definition at line 113 of file Ifpack_OverlapFactorObject.h.

bool Ifpack_OverlapFactorObject::Allocated_ [protected]
 

Definition at line 114 of file Ifpack_OverlapFactorObject.h.

bool Ifpack_OverlapFactorObject::ValuesInitialized_ [protected]
 

Definition at line 115 of file Ifpack_OverlapFactorObject.h.

Ifpack_OverlapGraph* Ifpack_OverlapFactorObject::OverlapGraph_ [protected]
 

Definition at line 116 of file Ifpack_OverlapFactorObject.h.

Epetra_RowMatrix* Ifpack_OverlapFactorObject::UserMatrix_ [protected]
 

Definition at line 117 of file Ifpack_OverlapFactorObject.h.


The documentation for this class was generated from the following file:
Generated on Thu Sep 18 12:37:31 2008 for Ifpack Package Browser (Single Doxygen Collection) by doxygen 1.3.9.1