LOCA::Epetra::IdentityOp Class Reference

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

#include <LOCA_Epetra_IdentityOp.H>

Collaboration diagram for LOCA::Epetra::IdentityOp:

Collaboration graph
[legend]

List of all members.

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 char * Label () const
 Returns a character 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_Comm & Comm () const
 Returns a reference to the Epetra_Comm communicator associated with this operator.
virtual const Epetra_Map & OperatorDomainMap () const
 Returns the Epetra_Map object associated with the domain of this matrix operator.
virtual const Epetra_Map & OperatorRangeMap () const
 Returns the Epetra_Map object associated with the range of this matrix operator.

Protected Attributes

string label
 Label for operator.
Teuchos::RCP< const Epetra_Comm > comm
 Stores comm.
Teuchos::RCP< const Epetra_Map > map
 Stores map.
bool useTranspose
 Flag indicating whether transpose was selected.

Private Member Functions

 IdentityOp (const IdentityOp &)
 Private to prohibit copying.
IdentityOpoperator= (const IdentityOp &)
 Private to prohibit copying.


Detailed Description

An Epetra operator representing the identity matrix.

Definition at line 57 of file LOCA_Epetra_IdentityOp.H.


Constructor & Destructor Documentation

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

Definition at line 48 of file LOCA_Epetra_IdentityOp.C.

LOCA::Epetra::IdentityOp::~IdentityOp (  )  [virtual]

Destructor.

Definition at line 58 of file LOCA_Epetra_IdentityOp.C.

LOCA::Epetra::IdentityOp::IdentityOp ( const IdentityOp  )  [private]

Private to prohibit copying.


Member Function Documentation

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

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

Definition at line 63 of file LOCA_Epetra_IdentityOp.C.

References useTranspose.

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.

Definition at line 70 of file LOCA_Epetra_IdentityOp.C.

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.

Definition at line 79 of file LOCA_Epetra_IdentityOp.C.

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

Returns an approximate infinity norm of the operator matrix.

Definition at line 88 of file LOCA_Epetra_IdentityOp.C.

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

Returns a character string describing the operator.

Definition at line 95 of file LOCA_Epetra_IdentityOp.C.

References label.

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

Returns the current UseTranspose setting.

Definition at line 101 of file LOCA_Epetra_IdentityOp.C.

References useTranspose.

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

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

Definition at line 107 of file LOCA_Epetra_IdentityOp.C.

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

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

Definition at line 113 of file LOCA_Epetra_IdentityOp.C.

References comm.

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

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

Definition at line 118 of file LOCA_Epetra_IdentityOp.C.

References map.

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

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

Definition at line 124 of file LOCA_Epetra_IdentityOp.C.

References map.

IdentityOp& LOCA::Epetra::IdentityOp::operator= ( const IdentityOp  )  [private]

Private to prohibit copying.


Member Data Documentation

string LOCA::Epetra::IdentityOp::label [protected]

Label for operator.

Definition at line 133 of file LOCA_Epetra_IdentityOp.H.

Referenced by Label().

Teuchos::RCP<const Epetra_Comm> LOCA::Epetra::IdentityOp::comm [protected]

Stores comm.

Definition at line 136 of file LOCA_Epetra_IdentityOp.H.

Referenced by Comm().

Teuchos::RCP<const Epetra_Map> LOCA::Epetra::IdentityOp::map [protected]

Stores map.

Definition at line 139 of file LOCA_Epetra_IdentityOp.H.

Referenced by OperatorDomainMap(), and OperatorRangeMap().

Flag indicating whether transpose was selected.

Definition at line 142 of file LOCA_Epetra_IdentityOp.H.

Referenced by SetUseTranspose(), and UseTranspose().


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

Generated on Wed Oct 21 14:28:30 2009 for Nonlinear Solver Project by  doxygen 1.5.9