|
PyTrilinos
Development
|
Public Member Functions | |
| def | __init__ |
| def | Apply |
| def | ApplyInverse |
| def | Label |
| def | UseTranspose |
| def | SetUseTranspose |
| def | HasNormInf |
| def | NormInf |
| def | Comm |
| def | OperatorDomainMap |
| def | OperatorRangeMap |
Public Attributes | |
| this | |
Proxy of C++ Anasazi::EpetraSymOp class
| def PyTrilinos.Anasazi.EpetraSymOp.__init__ | ( | self, | |
| args | |||
| ) |
__init__(Anasazi::EpetraSymOp self, Teuchos::RCP< Epetra_Operator > const & Op, bool isTrans=False) -> EpetraSymOp
Reimplemented from PyTrilinos.Epetra.Operator.
| def PyTrilinos.Anasazi.EpetraSymOp.Apply | ( | self, | |
| args | |||
| ) |
Apply(self, MultiVector x, MultiVector y) -> int
In C++, the Apply() method is pure virtual, thus intended to be
overridden by derived classes. In python, cross-language polymorphism
is supported, and you are expected to derive classes from this base
class and redefine the Apply() method. C++ code (e.g., AztecOO
solvers) can call back to your Apply() method as needed. You must
support two arguments, labeled here MultiVector x and MultiVector y.
These will be converted from Epetra_MultiVector C++ objects to
numpy-hybrid Epetra.MultiVector objects before they are passed to you.
Thus, it is legal to use slice indexing and other numpy features to
compute y from x.
If application of your operator is successful, return 0; else return
some non-zero error code.
It is strongly suggested that you prevent Apply() from raising any
exceptions. Accidental errors can be prevented by wrapping your code
in a try block:
try:
# Your code goes here...
except Exception, e:
print 'A python exception was raised by method Apply:'
print e
return -1
By returning a -1, you inform the calling routine that Apply() was
unsuccessful.
Apply(self, MultiVector x, MultiVector y) -> int
In C++, the Apply() method is pure virtual, thus intended to be
overridden by derived classes. In python, cross-language polymorphism
is supported, and you are expected to derive classes from this base
class and redefine the Apply() method. C++ code (e.g., AztecOO
solvers) can call back to your Apply() method as needed. You must
support two arguments, labeled here MultiVector x and MultiVector y.
These will be converted from Epetra_MultiVector C++ objects to
numpy-hybrid Epetra.MultiVector objects before they are passed to you.
Thus, it is legal to use slice indexing and other numpy features to
compute y from x.
If application of your operator is successful, return 0; else return
some non-zero error code.
It is strongly suggested that you prevent Apply() from raising any
exceptions. Accidental errors can be prevented by wrapping your code
in a try block:
try:
# Your code goes here...
except Exception, e:
print 'A python exception was raised by method Apply:'
print e
return -1
By returning a -1, you inform the calling routine that Apply() was
unsuccessful.
virtual int
Epetra_Operator::Apply(const Epetra_MultiVector &X, Epetra_MultiVector
&Y) const =0
Returns the result of a Epetra_Operator applied to a
Epetra_MultiVector X in Y.
Parameters:
-----------
In: X - A Epetra_MultiVector of dimension NumVectors to multiply with
matrix.
Out: Y -A Epetra_MultiVector of dimension NumVectors containing
result.
Integer error code, set to 0 if successful.
Reimplemented from PyTrilinos.Anasazi.OperatorDouble.
| def PyTrilinos.Anasazi.EpetraSymOp.ApplyInverse | ( | self, | |
| args | |||
| ) |
ApplyInverse(self, MultiVector x, MultiVector y) -> int
In C++, the ApplyInverse() method is pure virtual, thus intended to be
overridden by derived classes. In python, cross-language polymorphism
is supported, and you are expected to derive classes from this base
class and redefine the ApplyInverse() method. C++ code (e.g., AztecOO
solvers) can call back to your ApplyInverse() method as needed. You
must support two arguments, labeled here MultiVector x and MultiVector
y. These will be converted from Epetra_MultiVector C++ objects to
numpy-hybrid Epetra.MultiVector objects before they are passed to you.
Thus, it is legal to use slice indexing and other numpy features to
compute y from x.
If application of your operator is successful, return 0; else return
some non-zero error code.
It is strongly suggested that you prevent ApplyInverse() from raising
any exceptions. Accidental errors can be prevented by wrapping your
code in a try block:
try:
# Your code goes here...
except Exception, e:
print 'A python exception was raised by method ApplyInverse:'
print e
return -1
By returning a -1, you inform the calling routine that ApplyInverse()
was unsuccessful.
virtual int
Epetra_Operator::ApplyInverse(const Epetra_MultiVector &X,
Epetra_MultiVector &Y) const =0
Returns the result of a Epetra_Operator inverse applied to an
Epetra_MultiVector X in Y.
Parameters:
-----------
In: X - A Epetra_MultiVector of dimension NumVectors to solve for.
Out: Y -A Epetra_MultiVector of dimension NumVectors containing
result.
Integer error code, set to 0 if successful.
WARNING: In order to work with AztecOO, any implementation of this
method must support the case where X and Y are the same object.
Reimplemented from PyTrilinos.Epetra.Operator.
| def PyTrilinos.Anasazi.EpetraSymOp.Comm | ( | self, | |
| args | |||
| ) |
Comm(EpetraSymOp self) -> Comm virtual const Epetra_Comm& Epetra_Operator::Comm() const =0 Returns a pointer to the Epetra_Comm communicator associated with this operator.
Reimplemented from PyTrilinos.Epetra.Operator.
| def PyTrilinos.Anasazi.EpetraSymOp.HasNormInf | ( | self, | |
| args | |||
| ) |
HasNormInf(EpetraSymOp self) -> bool virtual bool Epetra_Operator::HasNormInf() const =0 Returns true if the this object can provide an approximate Inf-norm, false otherwise.
Reimplemented from PyTrilinos.Epetra.Operator.
| def PyTrilinos.Anasazi.EpetraSymOp.Label | ( | self, | |
| args | |||
| ) |
Label(EpetraSymOp self) -> char const * virtual const char* Epetra_Operator::Label() const =0 Returns a character string describing the operator.
Reimplemented from PyTrilinos.Epetra.Operator.
| def PyTrilinos.Anasazi.EpetraSymOp.NormInf | ( | self, | |
| args | |||
| ) |
NormInf(EpetraSymOp self) -> double virtual double Epetra_Operator::NormInf() const =0 Returns the infinity norm of the global matrix.
Reimplemented from PyTrilinos.Epetra.Operator.
| def PyTrilinos.Anasazi.EpetraSymOp.OperatorDomainMap | ( | self, | |
| args | |||
| ) |
OperatorDomainMap(EpetraSymOp self) -> Map virtual const Epetra_Map& Epetra_Operator::OperatorDomainMap() const =0 Returns the Epetra_Map object associated with the domain of this operator.
Reimplemented from PyTrilinos.Epetra.Operator.
| def PyTrilinos.Anasazi.EpetraSymOp.OperatorRangeMap | ( | self, | |
| args | |||
| ) |
OperatorRangeMap(EpetraSymOp self) -> Map virtual const Epetra_Map& Epetra_Operator::OperatorRangeMap() const =0 Returns the Epetra_Map object associated with the range of this operator.
Reimplemented from PyTrilinos.Epetra.Operator.
| def PyTrilinos.Anasazi.EpetraSymOp.SetUseTranspose | ( | self, | |
| args | |||
| ) |
SetUseTranspose(EpetraSymOp self, bool arg2) -> int virtual int Epetra_Operator::SetUseTranspose(bool UseTranspose)=0 If set true, transpose of this operator will be applied. This flag allows the transpose of the given operator to be used implicitly. Setting this flag affects only the Apply() and ApplyInverse() methods. If the implementation of this interface does not support transpose use, this method should return a value of -1. Parameters: ----------- In: UseTranspose -If true, multiply by the transpose of operator, otherwise just use operator. Integer error code, set to 0 if successful. Set to -1 if this implementation does not support transpose.
Reimplemented from PyTrilinos.Epetra.Operator.
| def PyTrilinos.Anasazi.EpetraSymOp.UseTranspose | ( | self, | |
| args | |||
| ) |
UseTranspose(EpetraSymOp self) -> bool virtual bool Epetra_Operator::UseTranspose() const =0 Returns the current UseTranspose setting.
Reimplemented from PyTrilinos.Epetra.Operator.
1.7.6.1