PyTrilinos.TriUtils.CrsMatrixGallery Class Reference

Inheritance diagram for PyTrilinos.TriUtils.CrsMatrixGallery:

Collaboration diagram for PyTrilinos.TriUtils.CrsMatrixGallery:

List of all members.

Public Member Functions
def	__init__
def	Set
def	GetMatrix
def	GetMatrixRef
def	GetExactSolution
def	GetStartingSolution
def	GetRHS
def	GetMap
def	GetMapRef
def	GetLinearProblem
def	ComputeResidual
def	ComputeDiffBetweenStartingAndExactSolutions
def	PrintMatrixAndVectors
def	GetCartesianCoordinates
def	WriteMatrix
Public Attributes
	this

---

Detailed Description

Proxy of C++ Trilinos_Util::CrsMatrixGallery class

---

Constructor & Destructor Documentation

def PyTrilinos.TriUtils.CrsMatrixGallery.__init__	(		self,
			args
	)

__init__(Trilinos_Util::CrsMatrixGallery self, string const name, Comm comm) -> CrsMatrixGallery
__init__(Trilinos_Util::CrsMatrixGallery self, string const name, Map map) -> CrsMatrixGallery

Trilinos_Util::CrsMatrixGallery::CrsMatrixGallery(const string name,
const Epetra_Map &map)

Creates an Triutils_Gallery object using a given map.

Create a Triutils_Gallery object using an Epetra_Map. Problem size
must match the elements in map.

Parameters:
-----------

In:  name - definition of the problem to be created.

In:  map - Epetra_Map 

Reimplemented in PyTrilinos.TriUtils.VbrMatrixGallery.

---

Member Function Documentation

def PyTrilinos.TriUtils.CrsMatrixGallery.ComputeDiffBetweenStartingAndExactSolutions	(		self,
			args
	)

ComputeDiffBetweenStartingAndExactSolutions(CrsMatrixGallery self, double * residual)

void
Trilinos_Util::CrsMatrixGallery::ComputeDiffBetweenStartingAndExactSolutions(double
*residual)

Computes the 2-norm of the difference between the starting solution
and the exact solution. 

def PyTrilinos.TriUtils.CrsMatrixGallery.ComputeResidual	(		self,
			args
	)

ComputeResidual(CrsMatrixGallery self, double * residual)

void
Trilinos_Util::CrsMatrixGallery::ComputeResidual(double *residual)

Computes the 2-norm of the residual. 

def PyTrilinos.TriUtils.CrsMatrixGallery.GetCartesianCoordinates	(		self,
			args
	)

GetCartesianCoordinates(CrsMatrixGallery self, double *& x, double *& y, double *& z)

void
Trilinos_Util::CrsMatrixGallery::GetCartesianCoordinates(double *&x,
double *&y, double *&z)

Get pointers to double vectors containing coordinates of points. 

def PyTrilinos.TriUtils.CrsMatrixGallery.GetExactSolution	(		self,
			args
	)

GetExactSolution(CrsMatrixGallery self) -> Epetra_MultiVector

Epetra_MultiVector
* Trilinos_Util::CrsMatrixGallery::GetExactSolution()

Returns a pointer to the exact solution.

Returns a pointer to the exact solution.

Some choices are available to define the exact solution, using
Set("exact solution", value). value can be: constant: the exact
solution vector is made up of 1's.

random: a random solution vector

linear: value at node i is defined as alpha*i. The double value alpha
can be set via Set("alpha",DoubleVal). 

def PyTrilinos.TriUtils.CrsMatrixGallery.GetLinearProblem	(		self,
			args
	)

GetLinearProblem(CrsMatrixGallery self) -> LinearProblem

Epetra_LinearProblem *
Trilinos_Util::CrsMatrixGallery::GetLinearProblem()

Returns a pointer to Epetra_LinearProblem. 

def PyTrilinos.TriUtils.CrsMatrixGallery.GetMap	(		self,
			args
	)

GetMap(CrsMatrixGallery self) -> Map

const
Epetra_Map * Trilinos_Util::CrsMatrixGallery::GetMap()

Returns a pointer the internally stored Map. 

def PyTrilinos.TriUtils.CrsMatrixGallery.GetMapRef	(		self,
			args
	)

GetMapRef(CrsMatrixGallery self) -> Map

const Epetra_Map & Trilinos_Util::CrsMatrixGallery::GetMapRef() 

def PyTrilinos.TriUtils.CrsMatrixGallery.GetMatrix	(		self,
			args
	)

GetMatrix(CrsMatrixGallery self) -> CrsMatrix

Epetra_CrsMatrix * Trilinos_Util::CrsMatrixGallery::GetMatrix()

Returns a pointer to the CrsMatrix. 

def PyTrilinos.TriUtils.CrsMatrixGallery.GetMatrixRef	(		self,
			args
	)

GetMatrixRef(CrsMatrixGallery self) -> CrsMatrix

Epetra_CrsMatrix & Trilinos_Util::CrsMatrixGallery::GetMatrixRef() 

def PyTrilinos.TriUtils.CrsMatrixGallery.GetRHS	(		self,
			args
	)

GetRHS(CrsMatrixGallery self) -> Epetra_MultiVector

Epetra_MultiVector * Trilinos_Util::CrsMatrixGallery::GetRHS()

Returns a pointer to the rhs corresponding to the selected exact
solution. 

def PyTrilinos.TriUtils.CrsMatrixGallery.GetStartingSolution	(		self,
			args
	)

GetStartingSolution(CrsMatrixGallery self) -> Epetra_MultiVector

Epetra_MultiVector *
Trilinos_Util::CrsMatrixGallery::GetStartingSolution()

Returns a pointer to the starting solution (typically, for HB
problems).

Returns a pointer to the starting solution. This is typically used
while reading a HB problem. However, the user can set a starting
solution using Set("starting solution", "value"). Value can be
zero

random 

def PyTrilinos.TriUtils.CrsMatrixGallery.PrintMatrixAndVectors	(		self,
			args
	)

PrintMatrixAndVectors(CrsMatrixGallery self, ostream & os)
PrintMatrixAndVectors(CrsMatrixGallery self)

void
Trilinos_Util::CrsMatrixGallery::PrintMatrixAndVectors() 

def PyTrilinos.TriUtils.CrsMatrixGallery.Set	(		self,
			args
	)

Set(CrsMatrixGallery self, string const parameter, int const value) -> int
Set(CrsMatrixGallery self, string const parameter, string const value) -> int
Set(CrsMatrixGallery self, string const parameter, double const value) -> int
Set(CrsMatrixGallery self, string const parameter, Epetra_Vector value) -> int
Set(CrsMatrixGallery self, Trilinos_Util::CommandLineParser & CLP) -> int

int
Trilinos_Util::CrsMatrixGallery::Set(Trilinos_Util::CommandLineParser
&CLP)

Sets gallery options using values passed from the shell. 

def PyTrilinos.TriUtils.CrsMatrixGallery.WriteMatrix	(		self,
			args
	)

WriteMatrix(CrsMatrixGallery self, string const & FileName, bool const UseSparse=True) -> int

int Trilinos_Util::CrsMatrixGallery::WriteMatrix(const string
&FileName, const bool UseSparse=true)

Print matrix on file in MATLAB format. 

---

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

• TriUtils.py