NOX Development
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
LOCA::Epetra::IdentityOp Class Reference

An Epetra operator representing the identity matrix. More...

#include <LOCA_Epetra_IdentityOp.H>

Inheritance diagram for LOCA::Epetra::IdentityOp:
Inheritance graph
[legend]
Collaboration diagram for LOCA::Epetra::IdentityOp:
Collaboration graph
[legend]

Public Member Functions

 IdentityOp (const Teuchos::RCP< const Epetra_Comm > &comm, const Teuchos::RCP< const Epetra_Map > &map)
 Constructor.
 
virtual ~IdentityOp ()
 Destructor.
 
virtual int SetUseTranspose (bool UseTranspose)
 Set to true if the transpose of the operator is requested.
 
virtual int Apply (const Epetra_MultiVector &Input, Epetra_MultiVector &Result) const
 Returns the result of a Epetra_Operator applied to a Epetra_MultiVector Input in Result as described above.
 
virtual int ApplyInverse (const Epetra_MultiVector &X, Epetra_MultiVector &Y) const
 Returns the result of the inverse of the operator applied to a Epetra_MultiVector Input in Result as described above.
 
virtual double NormInf () const
 Returns an approximate infinity norm of the operator matrix.
 
virtual const charLabel () const
 Returns a character std::string describing the operator.
 
virtual bool UseTranspose () const
 Returns the current UseTranspose setting.
 
virtual bool HasNormInf () const
 Returns true if the this object can provide an approximate Inf-norm, false otherwise.
 
virtual const Epetra_CommComm () const
 Returns a reference to the Epetra_Comm communicator associated with this operator.
 
virtual const Epetra_MapOperatorDomainMap () const
 Returns the Epetra_Map object associated with the domain of this matrix operator.
 
virtual const Epetra_MapOperatorRangeMap () const
 Returns the Epetra_Map object associated with the range of this matrix operator.
 

Protected Attributes

std::string label
 Label for operator.
 
Teuchos::RCP< const Epetra_Commcomm
 Stores comm.
 
Teuchos::RCP< const Epetra_Mapmap
 Stores map.
 
bool useTranspose
 Flag indicating whether transpose was selected.
 

Detailed Description

An Epetra operator representing the identity matrix.

Constructor & Destructor Documentation

◆ IdentityOp()

LOCA::Epetra::IdentityOp::IdentityOp ( const Teuchos::RCP< const Epetra_Comm > & comm,
const Teuchos::RCP< const Epetra_Map > & map )

Constructor.

Parameters
comm[in] Comm object
map[in] Map object

Member Function Documentation

◆ Apply()

int LOCA::Epetra::IdentityOp::Apply ( const Epetra_MultiVector & Input,
Epetra_MultiVector & Result ) const
virtual

Returns the result of a Epetra_Operator applied to a Epetra_MultiVector Input in Result as described above.

Implements Epetra_Operator.

References Epetra_MultiVector::Scale().

◆ ApplyInverse()

int LOCA::Epetra::IdentityOp::ApplyInverse ( const Epetra_MultiVector & X,
Epetra_MultiVector & Y ) const
virtual

Returns the result of the inverse of the operator applied to a Epetra_MultiVector Input in Result as described above.

Implements Epetra_Operator.

References Epetra_MultiVector::Scale().

◆ Comm()

const Epetra_Comm & LOCA::Epetra::IdentityOp::Comm ( ) const
virtual

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

Implements Epetra_Operator.

◆ HasNormInf()

bool LOCA::Epetra::IdentityOp::HasNormInf ( ) const
virtual

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

Implements Epetra_Operator.

◆ Label()

const char * LOCA::Epetra::IdentityOp::Label ( ) const
virtual

Returns a character std::string describing the operator.

Implements Epetra_Operator.

◆ NormInf()

double LOCA::Epetra::IdentityOp::NormInf ( ) const
virtual

Returns an approximate infinity norm of the operator matrix.

Implements Epetra_Operator.

◆ OperatorDomainMap()

const Epetra_Map & LOCA::Epetra::IdentityOp::OperatorDomainMap ( ) const
virtual

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

Implements Epetra_Operator.

◆ OperatorRangeMap()

const Epetra_Map & LOCA::Epetra::IdentityOp::OperatorRangeMap ( ) const
virtual

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

Implements Epetra_Operator.

◆ SetUseTranspose()

int LOCA::Epetra::IdentityOp::SetUseTranspose ( bool UseTranspose)
virtual

Set to true if the transpose of the operator is requested.

Implements Epetra_Operator.

◆ UseTranspose()

bool LOCA::Epetra::IdentityOp::UseTranspose ( ) const
virtual

Returns the current UseTranspose setting.

Implements Epetra_Operator.


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