Epetra_LinearProblem Class Reference

Epetra_LinearProblem: The Epetra Linear Problem Class. More...

#include <Epetra_LinearProblem.h>

List of all members.

Set methods
enum	ProblemDifficultyLevel { easy, moderate, hard, unsure }
void	AssertSymmetric ()
void	SetPDL (ProblemDifficultyLevel PDL)
	Set problem difficulty level.
void	SetOperator (Epetra_RowMatrix *A)
	Set Operator A of linear problem AX = B using an Epetra_RowMatrix.
void	SetOperator (Epetra_Operator *A)
	Set Operator A of linear problem AX = B using an Epetra_Operator.
void	SetLHS (Epetra_MultiVector *X)
	Set left-hand-side X of linear problem AX = B.
void	SetRHS (Epetra_MultiVector *B)
	Set right-hand-side B of linear problem AX = B.
Constructors/Destructor
	Epetra_LinearProblem (void)
	Epetra_LinearProblem Default Constructor.
	Epetra_LinearProblem (Epetra_RowMatrix *A, Epetra_MultiVector *X, Epetra_MultiVector *B)
	Epetra_LinearProblem Constructor to pass in an operator as a matrix.
	Epetra_LinearProblem (Epetra_Operator *A, Epetra_MultiVector *X, Epetra_MultiVector *B)
	Epetra_LinearProblem Constructor to pass in a basic Epetra_Operator.
	Epetra_LinearProblem (const Epetra_LinearProblem &Problem)
	Epetra_LinearProblem Copy Constructor.
virtual	~Epetra_LinearProblem (void)
	Epetra_LinearProblem Destructor.
Integrity check method
int	CheckInput () const
	Check input parameters for existence and size consistency.
Computational methods
int	LeftScale (const Epetra_Vector &D)
	Perform left scaling of a linear problem.
int	RightScale (const Epetra_Vector &D)
	Perform right scaling of a linear problem.
Accessor methods
Epetra_Operator *	GetOperator () const
	Get a pointer to the operator A.
Epetra_RowMatrix *	GetMatrix () const
	Get a pointer to the matrix A.
Epetra_MultiVector *	GetLHS () const
	Get a pointer to the left-hand-side X.
Epetra_MultiVector *	GetRHS () const
	Get a pointer to the right-hand-side B.
ProblemDifficultyLevel	GetPDL () const
	Get problem difficulty level.
bool	IsOperatorSymmetric () const
	Get operator symmetry bool.
Private Member Functions
Epetra_LinearProblem &	operator= (const Epetra_LinearProblem &Problem)
Private Attributes
Epetra_Operator *	Operator_
Epetra_RowMatrix *	A_
Epetra_MultiVector *	X_
Epetra_MultiVector *	B_
bool	OperatorSymmetric_
ProblemDifficultyLevel	PDL_
bool	LeftScaled_
bool	RightScaled_
Epetra_Vector *	LeftScaleVector_
Epetra_Vector *	RightScaleVector_

---

Detailed Description

Epetra_LinearProblem: The Epetra Linear Problem Class.

The Epetra_LinearProblem class is a wrapper that encapsulates the general information needed for solving a linear system of equations. Currently it accepts a Epetra matrix, initial guess and RHS and returns the solution. the elapsed time for each calling processor.

Definition at line 50 of file Epetra_LinearProblem.h.

---

Member Enumeration Documentation

enum Epetra_LinearProblem::ProblemDifficultyLevel

Enumeration values: easy  moderate  hard  unsure  Definition at line 100 of file Epetra_LinearProblem.h.

---

Constructor & Destructor Documentation

Epetra_LinearProblem::Epetra_LinearProblem (  void   )

Epetra_LinearProblem Default Constructor. Creates an empty Epetra_LinearProblem instance. The operator A, left-hand-side X and right-hand-side B must be set use the SetOperator(), SetLHS() and SetRHS() methods respectively. Definition at line 37 of file Epetra_LinearProblem.cpp.

Epetra_LinearProblem::Epetra_LinearProblem (  Epetra_RowMatrix *  A, Epetra_MultiVector *  X, Epetra_MultiVector *  B )

Epetra_LinearProblem Constructor to pass in an operator as a matrix. Creates a Epetra_LinearProblem instance where the operator is passed in as a matrix. Definition at line 51 of file Epetra_LinearProblem.cpp.

Epetra_LinearProblem::Epetra_LinearProblem (  Epetra_Operator *  A, Epetra_MultiVector *  X, Epetra_MultiVector *  B )

Epetra_LinearProblem Constructor to pass in a basic Epetra_Operator. Creates a Epetra_LinearProblem instance for the case where an operator is not necessarily a matrix. Definition at line 68 of file Epetra_LinearProblem.cpp.

Epetra_LinearProblem::Epetra_LinearProblem (  const Epetra_LinearProblem &  Problem  )

Epetra_LinearProblem Copy Constructor. Makes copy of an existing Epetra_LinearProblem instance. Definition at line 85 of file Epetra_LinearProblem.cpp.

Epetra_LinearProblem::~Epetra_LinearProblem (  void   )  [virtual]

Epetra_LinearProblem Destructor. Completely deletes a Epetra_LinearProblem object. Definition at line 99 of file Epetra_LinearProblem.cpp.

---

Member Function Documentation

int Epetra_LinearProblem::CheckInput (   )  const

Check input parameters for existence and size consistency. Returns 0 if all input parameters are valid. Returns +1 if operator is not a matrix. This is not necessarily an error, but no scaling can be done if the user passes in an Epetra_Operator that is not an Epetra_Matrix Definition at line 134 of file Epetra_LinearProblem.cpp.

void Epetra_LinearProblem::AssertSymmetric (   )  [inline]

Definition at line 98 of file Epetra_LinearProblem.h.

void Epetra_LinearProblem::SetPDL (  ProblemDifficultyLevel  PDL  )  [inline]

Set problem difficulty level. Sets Aztec options and parameters based on a definition of easy moderate or hard problem. Relieves the user from explicitly setting a large number of individual parameter values. This function can be used in conjunction with the SetOptions() and SetParams() functions. Definition at line 107 of file Epetra_LinearProblem.h.

void Epetra_LinearProblem::SetOperator (  Epetra_RowMatrix *  A  )  [inline]

Set Operator A of linear problem AX = B using an Epetra_RowMatrix. Sets a pointer to a Epetra_RowMatrix. No copy of the operator is made. Definition at line 112 of file Epetra_LinearProblem.h.

void Epetra_LinearProblem::SetOperator (  Epetra_Operator *  A  )  [inline]

Set Operator A of linear problem AX = B using an Epetra_Operator. Sets a pointer to a Epetra_Operator. No copy of the operator is made. Definition at line 118 of file Epetra_LinearProblem.h.

void Epetra_LinearProblem::SetLHS (  Epetra_MultiVector *  X  )  [inline]

Set left-hand-side X of linear problem AX = B. Sets a pointer to a Epetra_MultiVector. No copy of the object is made. Definition at line 124 of file Epetra_LinearProblem.h.

void Epetra_LinearProblem::SetRHS (  Epetra_MultiVector *  B  )  [inline]

Set right-hand-side B of linear problem AX = B. Sets a pointer to a Epetra_MultiVector. No copy of the object is made. Definition at line 129 of file Epetra_LinearProblem.h.

int Epetra_LinearProblem::LeftScale (  const Epetra_Vector &  D  )

Perform left scaling of a linear problem. Applies the scaling vector D to the left side of the matrix A() and to the right hand side B(). Note that the operator must be an Epetra_RowMatrix, not just an Epetra_Operator (the base class of Epetra_RowMatrix). Parameters: In  D - Vector containing scaling values. D[i] will be applied to the ith row of A() and B(). Returns: Integer error code, set to 0 if successful. Return -1 if operator is not a matrix. Definition at line 103 of file Epetra_LinearProblem.cpp.

int Epetra_LinearProblem::RightScale (  const Epetra_Vector &  D  )

Perform right scaling of a linear problem. Applies the scaling vector D to the right side of the matrix A(). Apply the inverse of D to the initial guess. Note that the operator must be an Epetra_RowMatrix, not just an Epetra_Operator (the base class of Epetra_RowMatrix). Parameters: In  D - Vector containing scaling values. D[i] will be applied to the ith row of A(). 1/D[i] will be applied to the ith row of B(). Returns: Integer error code, set to 0 if successful. Return -1 if operator is not a matrix. Definition at line 119 of file Epetra_LinearProblem.cpp.

Epetra_Operator* Epetra_LinearProblem::GetOperator (   )  const [inline]

Get a pointer to the operator A. Definition at line 161 of file Epetra_LinearProblem.h.

Epetra_RowMatrix* Epetra_LinearProblem::GetMatrix (   )  const [inline]

Get a pointer to the matrix A. Definition at line 163 of file Epetra_LinearProblem.h.

Epetra_MultiVector* Epetra_LinearProblem::GetLHS (   )  const [inline]

Get a pointer to the left-hand-side X. Definition at line 165 of file Epetra_LinearProblem.h.

Epetra_MultiVector* Epetra_LinearProblem::GetRHS (   )  const [inline]

Get a pointer to the right-hand-side B. Definition at line 167 of file Epetra_LinearProblem.h.

ProblemDifficultyLevel Epetra_LinearProblem::GetPDL (   )  const [inline]

Get problem difficulty level. Definition at line 169 of file Epetra_LinearProblem.h.

bool Epetra_LinearProblem::IsOperatorSymmetric (   )  const [inline]

Get operator symmetry bool. Definition at line 171 of file Epetra_LinearProblem.h.

Epetra_LinearProblem& Epetra_LinearProblem::operator= (  const Epetra_LinearProblem &  Problem  )  [private]

---

Member Data Documentation

Epetra_Operator* Epetra_LinearProblem::Operator_ [private]

Definition at line 176 of file Epetra_LinearProblem.h.

Epetra_RowMatrix* Epetra_LinearProblem::A_ [private]

Definition at line 177 of file Epetra_LinearProblem.h.

Epetra_MultiVector* Epetra_LinearProblem::X_ [private]

Definition at line 178 of file Epetra_LinearProblem.h.

Epetra_MultiVector* Epetra_LinearProblem::B_ [private]

Definition at line 179 of file Epetra_LinearProblem.h.

bool Epetra_LinearProblem::OperatorSymmetric_ [private]

Definition at line 181 of file Epetra_LinearProblem.h.

ProblemDifficultyLevel Epetra_LinearProblem::PDL_ [private]

Definition at line 182 of file Epetra_LinearProblem.h.

bool Epetra_LinearProblem::LeftScaled_ [private]

Definition at line 183 of file Epetra_LinearProblem.h.

bool Epetra_LinearProblem::RightScaled_ [private]

Definition at line 184 of file Epetra_LinearProblem.h.

Epetra_Vector* Epetra_LinearProblem::LeftScaleVector_ [private]

Definition at line 185 of file Epetra_LinearProblem.h.

Epetra_Vector* Epetra_LinearProblem::RightScaleVector_ [private]

Definition at line 186 of file Epetra_LinearProblem.h.

---

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

• Epetra_LinearProblem.h
• Epetra_LinearProblem.cpp

---