PyTrilinos.IFPACK.Factory Class Reference

Inheritance diagram for PyTrilinos.IFPACK.Factory:

Collaboration diagram for PyTrilinos.IFPACK.Factory:

List of all members.

Public Member Functions
def	toString
def	Create
def	SetParameters
def	__init__
Public Attributes
	this
Static Public Attributes
	POINT_RELAXATION = _IFPACK.Factory_POINT_RELAXATION
	POINT_RELAXATION_STAND_ALONE = _IFPACK.Factory_POINT_RELAXATION_STAND_ALONE
	BLOCK_RELAXATION = _IFPACK.Factory_BLOCK_RELAXATION
	BLOCK_RELAXATION_STAND_ALONE = _IFPACK.Factory_BLOCK_RELAXATION_STAND_ALONE
	BLOCK_RELAXATION_STAND_ALONE_ILU = _IFPACK.Factory_BLOCK_RELAXATION_STAND_ALONE_ILU
	BLOCK_RELAXATION_STAND_ALONE_AMESOS = _IFPACK.Factory_BLOCK_RELAXATION_STAND_ALONE_AMESOS
	BLOCK_RELAXATION_AMESOS = _IFPACK.Factory_BLOCK_RELAXATION_AMESOS
	AMESOS = _IFPACK.Factory_AMESOS
	AMESOS_STAND_ALONE = _IFPACK.Factory_AMESOS_STAND_ALONE
	IC = _IFPACK.Factory_IC
	IC_STAND_ALONE = _IFPACK.Factory_IC_STAND_ALONE
	ICT = _IFPACK.Factory_ICT
	ICT_STAND_ALONE = _IFPACK.Factory_ICT_STAND_ALONE
	ILU = _IFPACK.Factory_ILU
	ILU_STAND_ALONE = _IFPACK.Factory_ILU_STAND_ALONE
	ILUT = _IFPACK.Factory_ILUT
	ILUT_STAND_ALONE = _IFPACK.Factory_ILUT_STAND_ALONE
	CHEBYSHEV = _IFPACK.Factory_CHEBYSHEV
	IHSS = _IFPACK.Factory_IHSS
	SORA = _IFPACK.Factory_SORA
	numPrecTypes = _IFPACK.Factory_numPrecTypes

---

Detailed Description

Ifpack: a function class to define Ifpack preconditioners.

Class Ifpack is a function class, that contains just one method:
Create(). Using Create(), users can easily define a variety of IFPACK
preconditioners.

Create requires 3 arguments: a string, indicating the preconditioner
to be built;

a pointer to an Epetra_RowMatrix, representing the matrix to be used
to define the preconditioner;

an interger (defaulted to 0), that specifies the amount of overlap
among the processes.

The first argument can assume the following values:  "point
relaxation" : returns an instance of
Ifpack_AdditiveSchwarz<Ifpack_PointRelaxation>

"point relaxation stand-alone" : returns an instance of
Ifpack_PointRelaxation (value of overlap is ignored).

"block relaxation" : returns an instance of
Ifpack_AdditiveSchwarz<Ifpack_BlockRelaxation>

"block relaxation stand-alone)" : returns an instance of
Ifpack_BlockRelaxation.

"Amesos" : returns an instance of
Ifpack_AdditiveSchwarz<Ifpack_Amesos>.

"Amesos stand-alone" : returns an instance of Ifpack_Amesos.

"IC" : returns an instance of Ifpack_AdditiveSchwarz<Ifpack_IC>.

"IC stand-alone" : returns an instance of
Ifpack_AdditiveSchwarz<Ifpack_IC>.

"ICT" : returns an instance of Ifpack_AdditiveSchwarz<Ifpack_ICT>.

"ICT stand-alone" : returns an instance of Ifpack_ICT.

"ILU" : returns an instance of Ifpack_AdditiveSchwarz<Ifpack_ILU>.

"ILU stand-alone" : returns an instance of Ifpack_ILU.

"ILUT" : returns an instance of Ifpack_AdditiveSchwarz<Ifpack_ILUT>.

"ILUT stand-alone" : returns an instance of Ifpack_ILUT.

otherwise, Create() returns 0.

Objects in stand-alone mode cannot use reordering, variable overlap,
and singleton filters. However, their construction can be slightly
faster than the non stand-alone counterpart.

The following fragment of code shows the basic usage of this class.

Marzio Sala, (formally) SNL org. 1414

C++ includes: Ifpack.h 

---

Constructor & Destructor Documentation

def PyTrilinos.IFPACK.Factory.__init__	(		self,
			args
	)

__init__(Ifpack self) -> Factory

---

Member Function Documentation

def PyTrilinos.IFPACK.Factory.Create	(		self,
			args
	)

Create(Factory self, Ifpack::EPrecType PrecType, RowMatrix Matrix, int const overlap=0) -> Preconditioner
Create(Factory self, string const PrecType, RowMatrix Matrix, int const overlap=0) -> Preconditioner

Ifpack_Preconditioner *
Ifpack::Create(const string PrecType, Epetra_RowMatrix *Matrix, const
int overlap=0)

Creates an instance of Ifpack_Preconditioner given the string name of
the preconditioner type (can fail with bad input).

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

PrecType:  (In) - String name of preconditioner type to be created.

Matrix:  (In) - Matrix used to define the preconditioner

overlap:  (In) - specified overlap, defaulted to 0.

Returns 0 if the preconditioner with that input name does not exist.
Otherwise, return a newly created preconditioner object. Note that the
client is responsible for calling delete on the returned object once
it is finished using it! 

def PyTrilinos.IFPACK.Factory.SetParameters	(		self,
			args
	)

SetParameters(Factory self, int argc, char *[] argv, ParameterList List, string & PrecType, int & Overlap) -> int

int
Ifpack::SetParameters(int argc, char *argv[], Teuchos::ParameterList
&List, string &PrecType, int &Overlap)

Sets the options in List from the command line.

Note: If you want full support for all parameters, consider reading in
a parameter list from an XML file as supported by the Teuchos helper
function Teuchos::updateParametersFromXmlFile() or
Teuchos::updateParametersFromXmlStream(). 

def PyTrilinos.IFPACK.Factory.toString

(

args

)

toString(Ifpack::EPrecType const precType) -> char const *

---

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

• IFPACK.py