MLAPI::InverseOperator Class Reference

InverseOperator: basic class to define smoother and coarse solvers. More...

#include <MLAPI_InverseOperator.h>

Inheritance diagram for MLAPI::InverseOperator:

Inheritance graph
[legend]
Collaboration diagram for MLAPI::InverseOperator:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 InverseOperator ()
 Empty constructor.
 InverseOperator (const Operator &Op, const string Type)
 Constructor for a given Operator and type, and default parameters.
 InverseOperator (const Operator &Op, const string Type, Teuchos::ParameterList &List)
 Constructor for a given Operator, type and parameters.
 InverseOperator (const InverseOperator &RHS)
 Copy constructor.
 ~InverseOperator ()
 Destructor.
InverseOperatoroperator= (const InverseOperator &RHS)
 Operator =.
void Reshape ()
 Resets this object.
void Reshape (const Operator &Op, const string Type)
 Reshapes the object with default values.
void Reshape (const Operator &Op, const string Type, Teuchos::ParameterList &List)
 Reshapes the object by setting the Operator and the specified type.
const Space GetOperatorRangeSpace () const
 Returns a reference to the range space of this object.
const Space GetOperatorDomainSpace () const
 Returns a reference to the domain space of this object.
const Space GetRangeSpace () const
 Returns a reference to the range space of this object.
const Space GetDomainSpace () const
 Returns a reference to the domain space of this object.
const Teuchos::RefCountPtr
< Epetra_RowMatrix > 
RCPRowMatrix () const
 Returns pointer of the internally stored ML_Epetra::RowMatrix object.
Epetra_RowMatrix * RowMatrix () const
 Returns pointer of the internally stored ML_Epetra::RowMatrix object.
const OperatorGetOperator () const
 Returns a reference to the Operator of which this object defines the inverse.
Teuchos::RefCountPtr
< Ifpack_Preconditioner > & 
GetRCPData ()
 Returns a pointer to the internally stored IFPACK preconditioner.
Teuchos::RefCountPtr
< ML_Epetra::MultiLevelPreconditioner > & 
GetRCPMLPrec ()
 Returns a pointer to the internally stored IFPACK preconditioner.
const Teuchos::RefCountPtr
< Ifpack_Preconditioner > & 
GetRCPData () const
 Returns a pointer to the internally stored IFPACK preconditioner.
const Teuchos::RefCountPtr
< ML_Epetra::MultiLevelPreconditioner > & 
GetRCPMLPrec () const
 Returns a pointer to the internally stored ML preconditioner.
int Apply (const MultiVector &x, MultiVector &y) const
 Applies this object to vector lhs, returns values in rhs.
MultiVector operator() (const MultiVector &LHS)
 Applies the operator to LHS, returns the results.
MultiVector operator() (const MultiVector &LHS, const MultiVector &RHS)
 Applies the operator to LHS using RHS as initial solution, returns the results.
ostream & Print (std::ostream &os, const bool verbose=true) const
 Prints out basic information about this object.
Operator Op_
 Operator of which this object define the inverse.
Teuchos::RefCountPtr
< Epetra_RowMatrix > 
RCPRowMatrix_
 Wrapper for IFPACK.
Teuchos::RefCountPtr
< Ifpack_Preconditioner > 
RCPData_
 IFPACK preconditioner.
Teuchos::RefCountPtr
< ML_Epetra::MultiLevelPreconditioner
RCPMLPrec_
 ML preconditioner.
void Destroy ()


Detailed Description

Author:
Marzio Sala, D-INFK/ETHZ.
Date:
Last updated on Mar-06.

Constructor & Destructor Documentation

MLAPI::InverseOperator::InverseOperator (  )  [inline]

MLAPI::InverseOperator::InverseOperator ( const Operator Op,
const string  Type 
)

MLAPI::InverseOperator::InverseOperator ( const Operator Op,
const string  Type,
Teuchos::ParameterList &  List 
)

MLAPI::InverseOperator::InverseOperator ( const InverseOperator RHS  ) 

MLAPI::InverseOperator::~InverseOperator (  )  [inline]


Member Function Documentation

int MLAPI::InverseOperator::Apply ( const MultiVector x,
MultiVector y 
) const [virtual]

Implements MLAPI::BaseOperator.

void MLAPI::InverseOperator::Destroy (  )  [private]

const Space MLAPI::InverseOperator::GetDomainSpace (  )  const

const Operator& MLAPI::InverseOperator::GetOperator (  )  const

const Space MLAPI::InverseOperator::GetOperatorDomainSpace (  )  const [virtual]

Implements MLAPI::BaseOperator.

const Space MLAPI::InverseOperator::GetOperatorRangeSpace (  )  const [virtual]

Implements MLAPI::BaseOperator.

const Space MLAPI::InverseOperator::GetRangeSpace (  )  const

const Teuchos::RefCountPtr<Ifpack_Preconditioner>& MLAPI::InverseOperator::GetRCPData (  )  const

Teuchos::RefCountPtr<Ifpack_Preconditioner>& MLAPI::InverseOperator::GetRCPData (  ) 

const Teuchos::RefCountPtr<ML_Epetra::MultiLevelPreconditioner>& MLAPI::InverseOperator::GetRCPMLPrec (  )  const

Teuchos::RefCountPtr<ML_Epetra::MultiLevelPreconditioner>& MLAPI::InverseOperator::GetRCPMLPrec (  ) 

MultiVector MLAPI::InverseOperator::operator() ( const MultiVector LHS,
const MultiVector RHS 
)

MultiVector MLAPI::InverseOperator::operator() ( const MultiVector LHS  ) 

InverseOperator& MLAPI::InverseOperator::operator= ( const InverseOperator RHS  ) 

ostream& MLAPI::InverseOperator::Print ( std::ostream &  os,
const bool  verbose = true 
) const [virtual]

Implements MLAPI::BaseObject.

const Teuchos::RefCountPtr<Epetra_RowMatrix> MLAPI::InverseOperator::RCPRowMatrix (  )  const

void MLAPI::InverseOperator::Reshape ( const Operator Op,
const string  Type,
Teuchos::ParameterList &  List 
)

void MLAPI::InverseOperator::Reshape ( const Operator Op,
const string  Type 
)

void MLAPI::InverseOperator::Reshape (  ) 

Epetra_RowMatrix* MLAPI::InverseOperator::RowMatrix (  )  const


Member Data Documentation

Teuchos::RefCountPtr<Ifpack_Preconditioner> MLAPI::InverseOperator::RCPData_ [private]

Teuchos::RefCountPtr<Epetra_RowMatrix> MLAPI::InverseOperator::RCPRowMatrix_ [private]


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