PyTrilinos::Epetra::InvOperator Class Reference

Inheritance diagram for PyTrilinos::Epetra::InvOperator:

Inheritance graph
[legend]
Collaboration diagram for PyTrilinos::Epetra::InvOperator:

Collaboration graph
[legend]

List of all members.

Public Member Functions

def __init__
def SetUseTranspose
def Apply
def ApplyInverse
def NormInf
def Label
def Operator
def UseTranspose
def HasNormInf
def Comm
def OperatorDomainMap
def OperatorRangeMap
def __disown__
def __init__
def SetUseTranspose
def Apply
def ApplyInverse
def NormInf
def Label
def Operator
def UseTranspose
def HasNormInf
def Comm
def OperatorDomainMap
def OperatorRangeMap
def __disown__

Public Attributes

 this


Detailed Description

Epetra_InvOperator: An implementation of the Epetra_Operator class
that reverses the role of Apply() and ApplyInverse() methods.

The Epetra_InvOperator class implements Epetra_Operator using another
pre-constructed Epetra_Operator object. Once constructed, an
Epetra_InvOperator can be used as the inverse of the input operator
object as long as the appropriate Apply and ApplyInverse methods are
implemented in the original Epetra_Operator object.

C++ includes: Epetra_InvOperator.h 

Member Function Documentation

def PyTrilinos::Epetra::InvOperator::__init__ (   self,
  args 
)

__init__(self, Operator operatorIn) -> InvOperator

Epetra_InvOperator::Epetra_InvOperator(Epetra_Operator *operatorIn)

Uses an Epetra_Operator instance to implement the Epetra_Operator
interface.

Facilitates the use of an Epetra_Operator instance as an inverse
operator.

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

In:  - A fully-constructed Epetra_Operator object. 

Reimplemented from PyTrilinos::Epetra::Operator.

def PyTrilinos::Epetra::InvOperator::__init__ (   self,
  args 
)

__init__(self, Operator operatorIn) -> InvOperator

Epetra_InvOperator::Epetra_InvOperator(Epetra_Operator *operatorIn)

Uses an Epetra_Operator instance to implement the Epetra_Operator
interface.

Facilitates the use of an Epetra_Operator instance as an inverse
operator.

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

In:  - A fully-constructed Epetra_Operator object. 

Reimplemented from PyTrilinos::Epetra::Operator.

def PyTrilinos::Epetra::InvOperator::Apply (   self,
  args 
)

Apply(self, Epetra_MultiVector X, Epetra_MultiVector Y) -> int

int
Epetra_InvOperator::Apply(const Epetra_MultiVector &X,
Epetra_MultiVector &Y) const

Returns the result of a Epetra_InvOperator 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.

WARNING:  - This method has no effect and returns -1 as error code. 

Reimplemented from PyTrilinos::Epetra::Operator.

def PyTrilinos::Epetra::InvOperator::Apply (   self,
  args 
)

Apply(self, Epetra_MultiVector X, Epetra_MultiVector Y) -> int

int
Epetra_InvOperator::Apply(const Epetra_MultiVector &X,
Epetra_MultiVector &Y) const

Returns the result of a Epetra_InvOperator 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.

WARNING:  - This method has no effect and returns -1 as error code. 

Reimplemented from PyTrilinos::Epetra::Operator.

def PyTrilinos::Epetra::InvOperator::ApplyInverse (   self,
  args 
)

ApplyInverse(self, Epetra_MultiVector X, Epetra_MultiVector Y) -> int

int
Epetra_InvOperator::ApplyInverse(const Epetra_MultiVector &X,
Epetra_MultiVector &Y) const

Returns the result of a Epetra_InvOperator 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. 

Reimplemented from PyTrilinos::Epetra::Operator.

def PyTrilinos::Epetra::InvOperator::ApplyInverse (   self,
  args 
)

ApplyInverse(self, Epetra_MultiVector X, Epetra_MultiVector Y) -> int

int
Epetra_InvOperator::ApplyInverse(const Epetra_MultiVector &X,
Epetra_MultiVector &Y) const

Returns the result of a Epetra_InvOperator 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. 

Reimplemented from PyTrilinos::Epetra::Operator.

def PyTrilinos::Epetra::InvOperator::Comm (   self,
  args 
)

Comm(self) -> Comm

const Epetra_Comm&
Epetra_InvOperator::Comm() const

Returns a pointer to the Epetra_Comm communicator associated with this
operator. 

Reimplemented from PyTrilinos::Epetra::Operator.

def PyTrilinos::Epetra::InvOperator::Comm (   self,
  args 
)

Comm(self) -> Comm

const Epetra_Comm&
Epetra_InvOperator::Comm() const

Returns a pointer to the Epetra_Comm communicator associated with this
operator. 

Reimplemented from PyTrilinos::Epetra::Operator.

def PyTrilinos::Epetra::InvOperator::HasNormInf (   self,
  args 
)

HasNormInf(self) -> bool

bool
Epetra_InvOperator::HasNormInf() const

Returns true if the this object can provide an approximate Inf-norm,
false otherwise. 

Reimplemented from PyTrilinos::Epetra::Operator.

def PyTrilinos::Epetra::InvOperator::HasNormInf (   self,
  args 
)

HasNormInf(self) -> bool

bool
Epetra_InvOperator::HasNormInf() const

Returns true if the this object can provide an approximate Inf-norm,
false otherwise. 

Reimplemented from PyTrilinos::Epetra::Operator.

def PyTrilinos::Epetra::InvOperator::Label (   self,
  args 
)

Label(self) -> char

const char*
Epetra_InvOperator::Label() const

Returns a character string describing the operator. 

Reimplemented from PyTrilinos::Epetra::Operator.

def PyTrilinos::Epetra::InvOperator::Label (   self,
  args 
)

Label(self) -> char

const char*
Epetra_InvOperator::Label() const

Returns a character string describing the operator. 

Reimplemented from PyTrilinos::Epetra::Operator.

def PyTrilinos::Epetra::InvOperator::NormInf (   self,
  args 
)

NormInf(self) -> double

double
Epetra_InvOperator::NormInf() const

Returns the infinity norm of the global matrix. 

Reimplemented from PyTrilinos::Epetra::Operator.

def PyTrilinos::Epetra::InvOperator::NormInf (   self,
  args 
)

NormInf(self) -> double

double
Epetra_InvOperator::NormInf() const

Returns the infinity norm of the global matrix. 

Reimplemented from PyTrilinos::Epetra::Operator.

def PyTrilinos::Epetra::InvOperator::Operator (   self,
  args 
)

Operator(self) -> Operator

Epetra_Operator*
Epetra_InvOperator::Operator() const

Returns a pointer to the Epetra_Operator operator object that was used
to create this Epetra_InvOperator object. 

def PyTrilinos::Epetra::InvOperator::Operator (   self,
  args 
)

Operator(self) -> Operator

Epetra_Operator*
Epetra_InvOperator::Operator() const

Returns a pointer to the Epetra_Operator operator object that was used
to create this Epetra_InvOperator object. 

def PyTrilinos::Epetra::InvOperator::OperatorDomainMap (   self,
  args 
)

OperatorDomainMap(self) -> Map

const
Epetra_Map& Epetra_InvOperator::OperatorDomainMap() const

Returns the Epetra_BlockMap object associated with the domain of this
matrix operator. 

Reimplemented from PyTrilinos::Epetra::Operator.

def PyTrilinos::Epetra::InvOperator::OperatorDomainMap (   self,
  args 
)

OperatorDomainMap(self) -> Map

const
Epetra_Map& Epetra_InvOperator::OperatorDomainMap() const

Returns the Epetra_BlockMap object associated with the domain of this
matrix operator. 

Reimplemented from PyTrilinos::Epetra::Operator.

def PyTrilinos::Epetra::InvOperator::OperatorRangeMap (   self,
  args 
)

OperatorRangeMap(self) -> Map

const
Epetra_Map& Epetra_InvOperator::OperatorRangeMap() const

Returns the Epetra_BlockMap object associated with the range of this
matrix operator. 

Reimplemented from PyTrilinos::Epetra::Operator.

def PyTrilinos::Epetra::InvOperator::OperatorRangeMap (   self,
  args 
)

OperatorRangeMap(self) -> Map

const
Epetra_Map& Epetra_InvOperator::OperatorRangeMap() const

Returns the Epetra_BlockMap object associated with the range of this
matrix operator. 

Reimplemented from PyTrilinos::Epetra::Operator.

def PyTrilinos::Epetra::InvOperator::SetUseTranspose (   self,
  args 
)

SetUseTranspose(self, bool UseTranspose) -> int

int
Epetra_InvOperator::SetUseTranspose(bool UseTranspose)

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.

WARNING:  - This method has no effect and returns -1 as error code. 

Reimplemented from PyTrilinos::Epetra::Operator.

def PyTrilinos::Epetra::InvOperator::SetUseTranspose (   self,
  args 
)

SetUseTranspose(self, bool UseTranspose) -> int

int
Epetra_InvOperator::SetUseTranspose(bool UseTranspose)

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.

WARNING:  - This method has no effect and returns -1 as error code. 

Reimplemented from PyTrilinos::Epetra::Operator.

def PyTrilinos::Epetra::InvOperator::UseTranspose (   self,
  args 
)

UseTranspose(self) -> bool

bool
Epetra_InvOperator::UseTranspose() const

Returns the current UseTranspose setting. 

Reimplemented from PyTrilinos::Epetra::Operator.

def PyTrilinos::Epetra::InvOperator::UseTranspose (   self,
  args 
)

UseTranspose(self) -> bool

bool
Epetra_InvOperator::UseTranspose() const

Returns the current UseTranspose setting. 

Reimplemented from PyTrilinos::Epetra::Operator.


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

Generated on Thu Dec 17 11:00:21 2009 for PyTrilinos by  doxygen 1.5.9