AztecOOConditionNumber Class Reference

Condition number estimator using AztecOO. More...

#include <AztecOO_ConditionNumber.h>

Collaboration diagram for AztecOOConditionNumber:

Public Types
enum	SolverType { CG_ , GMRES_ }
	Solver type to use. More...

Public Member Functions
	AztecOOConditionNumber ()
	Constructor.
	~AztecOOConditionNumber ()
	Destructor.
void	initialize (const Epetra_Operator &op, SolverType solverType=GMRES_, int krylovSubspaceSize=100, bool printSolve=false)
	Initialization.
int	computeConditionNumber (int maxIters, double tol)
	Estimates the condition number.
double	getConditionNumber ()
	Return condition number computed by last call to computeConditionNumber.

Protected Member Functions
void	freeMemory ()
	Frees all memory allocated with new by this object.

Protected Attributes
double	conditionNumber_
	Condition number calculated in computeConditionNumber.
Epetra_Map *	domainMap_
	Map to create left hand side vector.
Epetra_Map *	rangeMap_
	Map to create right hand side vector.
Epetra_Operator *	operator_
	Operator supplied by user in initialization.
Epetra_Vector *	rhs_
	RHS vector. This is initializaed to a random vector.
Epetra_Vector *	dummy_
	Dummy vector. Initializaed to zero.
AztecOO *	solver_
	solver object.
bool	printSolve_
	Conditional for printing solve to output.

Detailed Description

Condition number estimator using AztecOO.

This object will estimate the condition number of an Epetra_Operator.

Member Enumeration Documentation

SolverType

enum AztecOOConditionNumber::SolverType

Solver type to use.

Enumerator
CG_	CG for symmetric matrices.
GMRES_	GMRES for nonsymmetric.

Constructor & Destructor Documentation

AztecOOConditionNumber()

AztecOOConditionNumber::AztecOOConditionNumber

(

)

Constructor.

References conditionNumber_, domainMap_, dummy_, operator_, printSolve_, rangeMap_, rhs_, and solver_.

~AztecOOConditionNumber()

AztecOOConditionNumber::~AztecOOConditionNumber

(

)

Destructor.

References freeMemory().

Member Function Documentation

computeConditionNumber()

int AztecOOConditionNumber::computeConditionNumber	(	int	maxIters,
		double	tol )

Estimates the condition number.

References conditionNumber_, AztecOO::GetAztecStatus(), AztecOO::Iterate(), and solver_.

freeMemory()

void AztecOOConditionNumber::freeMemory ( )

protected

Frees all memory allocated with new by this object.

References domainMap_, dummy_, rangeMap_, rhs_, and solver_.

Referenced by initialize(), and ~AztecOOConditionNumber().

getConditionNumber()

double AztecOOConditionNumber::getConditionNumber

(

)

Return condition number computed by last call to computeConditionNumber.

References conditionNumber_.

initialize()

void AztecOOConditionNumber::initialize	(	const Epetra_Operator &	op,
		SolverType	solverType = GMRES_,
		int	krylovSubspaceSize = 100,
		bool	printSolve = false )

Initialization.

References AztecOO::AztecOO(), domainMap_, dummy_, freeMemory(), GMRES_, operator_, rangeMap_, rhs_, AztecOO::SetAztecOption(), and solver_.

Member Data Documentation

conditionNumber_

double AztecOOConditionNumber::conditionNumber_

protected

Condition number calculated in computeConditionNumber.

Referenced by AztecOOConditionNumber(), computeConditionNumber(), and getConditionNumber().

domainMap_

Epetra_Map* AztecOOConditionNumber::domainMap_

protected

Map to create left hand side vector.

Referenced by AztecOOConditionNumber(), freeMemory(), and initialize().

dummy_

Epetra_Vector* AztecOOConditionNumber::dummy_

protected

Dummy vector. Initializaed to zero.

Referenced by AztecOOConditionNumber(), freeMemory(), and initialize().

operator_

Epetra_Operator* AztecOOConditionNumber::operator_

protected

Operator supplied by user in initialization.

Referenced by AztecOOConditionNumber(), and initialize().

printSolve_

bool AztecOOConditionNumber::printSolve_

protected

Conditional for printing solve to output.

Referenced by AztecOOConditionNumber().

rangeMap_

Epetra_Map* AztecOOConditionNumber::rangeMap_

protected

Map to create right hand side vector.

Referenced by AztecOOConditionNumber(), freeMemory(), and initialize().

rhs_

Epetra_Vector* AztecOOConditionNumber::rhs_

protected

RHS vector. This is initializaed to a random vector.

Referenced by AztecOOConditionNumber(), freeMemory(), and initialize().

solver_

AztecOO* AztecOOConditionNumber::solver_

protected

solver object.

Referenced by AztecOOConditionNumber(), computeConditionNumber(), freeMemory(), and initialize().

---

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

• AztecOO_ConditionNumber.h
• AztecOO_ConditionNumber.cpp