EpetraExt Package Browser (Single Doxygen Collection)  Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Protected Attributes | Private Member Functions | List of all members
EpetraExt::Epetra_Timed_Operator Class Reference

Class allows for timing the action and inverse action of an Epetra_Opetator. More...

#include <EpetraExt_TimedEpetraOperator.hpp>

Inheritance diagram for EpetraExt::Epetra_Timed_Operator:
Inheritance graph
[legend]

Public Member Functions

 Epetra_Timed_Operator (const Teuchos::RCP< Epetra_Operator > &A_)
 Constructor. More...
 
virtual ~Epetra_Timed_Operator ()
 Destructor. More...
 
int SetUseTranspose (bool useTranspose)
 Set to true if the transpose of the operator is requested. More...
 
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. More...
 
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. More...
 
virtual double NormInf () const
 Returns an approximate infinity norm of the operator matrix. More...
 
virtual const char * Label () const
 Returns a character string describing the operator. More...
 
virtual bool UseTranspose () const
 Returns the current UseTranspose setting. More...
 
virtual bool HasNormInf () const
 Returns true if the this object can provide an approximate Inf-norm, false otherwise. More...
 
virtual const Epetra_CommComm () const
 Returns a reference to the Epetra_Comm communicator associated with this operator. More...
 
virtual const Epetra_MapOperatorDomainMap () const
 Returns the Epetra_Map object associated with the domain of this matrix operator. More...
 
virtual const Epetra_MapOperatorRangeMap () const
 Returns the Epetra_Map object associated with the range of this matrix operator. More...
 
virtual double ApplyTime () const
 Returns the total time applying this operator. More...
 
virtual double ApplyInverseTime () const
 Returns the total time applying the inverse of this operator. More...
 
virtual Teuchos::RCP< const
Epetra_Operator
ReturnOperator () const
 Returns a pointer to the underlying Epetra_Operator. More...
 

Protected Attributes

Teuchos::RCP< Epetra_OperatorA
 Stores the base operator. More...
 
Teuchos::RCP< Teuchos::TimeApplyTimer
 Keeps track of the apply time. More...
 
Teuchos::RCP< Teuchos::TimeApplyInverseTimer
 Keeps track of the apply inverse time. More...
 

Private Member Functions

 Epetra_Timed_Operator (const Epetra_Timed_Operator &)
 Private to prohibit copying. More...
 
Epetra_Timed_Operatoroperator= (const Epetra_Timed_Operator &)
 Private to prohibit copying. More...
 

Detailed Description

Class allows for timing the action and inverse action of an Epetra_Opetator.

Definition at line 57 of file EpetraExt_TimedEpetraOperator.hpp.

Constructor & Destructor Documentation

EpetraExt::Epetra_Timed_Operator::Epetra_Timed_Operator ( const Teuchos::RCP< Epetra_Operator > &  A_)

Constructor.

Definition at line 45 of file EpetraExt_TimedEpetraOperator.cpp.

EpetraExt::Epetra_Timed_Operator::~Epetra_Timed_Operator ( )
virtual

Destructor.

Definition at line 52 of file EpetraExt_TimedEpetraOperator.cpp.

EpetraExt::Epetra_Timed_Operator::Epetra_Timed_Operator ( const Epetra_Timed_Operator )
private

Private to prohibit copying.

Member Function Documentation

int EpetraExt::Epetra_Timed_Operator::SetUseTranspose ( bool  useTranspose)
virtual

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

Implements Epetra_Operator.

Definition at line 57 of file EpetraExt_TimedEpetraOperator.cpp.

int EpetraExt::Epetra_Timed_Operator::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.

Definition at line 65 of file EpetraExt_TimedEpetraOperator.cpp.

int EpetraExt::Epetra_Timed_Operator::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.

Definition at line 76 of file EpetraExt_TimedEpetraOperator.cpp.

double EpetraExt::Epetra_Timed_Operator::NormInf ( ) const
virtual

Returns an approximate infinity norm of the operator matrix.

Implements Epetra_Operator.

Definition at line 87 of file EpetraExt_TimedEpetraOperator.cpp.

const char * EpetraExt::Epetra_Timed_Operator::Label ( ) const
virtual

Returns a character string describing the operator.

Implements Epetra_Operator.

Definition at line 94 of file EpetraExt_TimedEpetraOperator.cpp.

bool EpetraExt::Epetra_Timed_Operator::UseTranspose ( ) const
virtual

Returns the current UseTranspose setting.

Implements Epetra_Operator.

Definition at line 100 of file EpetraExt_TimedEpetraOperator.cpp.

bool EpetraExt::Epetra_Timed_Operator::HasNormInf ( ) const
virtual

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

Implements Epetra_Operator.

Definition at line 106 of file EpetraExt_TimedEpetraOperator.cpp.

const Epetra_Comm & EpetraExt::Epetra_Timed_Operator::Comm ( ) const
virtual

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

Implements Epetra_Operator.

Definition at line 112 of file EpetraExt_TimedEpetraOperator.cpp.

const Epetra_Map & EpetraExt::Epetra_Timed_Operator::OperatorDomainMap ( ) const
virtual

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

Implements Epetra_Operator.

Definition at line 117 of file EpetraExt_TimedEpetraOperator.cpp.

const Epetra_Map & EpetraExt::Epetra_Timed_Operator::OperatorRangeMap ( ) const
virtual

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

Implements Epetra_Operator.

Definition at line 123 of file EpetraExt_TimedEpetraOperator.cpp.

virtual double EpetraExt::Epetra_Timed_Operator::ApplyTime ( ) const
inlinevirtual

Returns the total time applying this operator.

Definition at line 120 of file EpetraExt_TimedEpetraOperator.hpp.

virtual double EpetraExt::Epetra_Timed_Operator::ApplyInverseTime ( ) const
inlinevirtual

Returns the total time applying the inverse of this operator.

Definition at line 125 of file EpetraExt_TimedEpetraOperator.hpp.

virtual Teuchos::RCP<const Epetra_Operator> EpetraExt::Epetra_Timed_Operator::ReturnOperator ( ) const
inlinevirtual

Returns a pointer to the underlying Epetra_Operator.

Definition at line 130 of file EpetraExt_TimedEpetraOperator.hpp.

Epetra_Timed_Operator& EpetraExt::Epetra_Timed_Operator::operator= ( const Epetra_Timed_Operator )
private

Private to prohibit copying.

Member Data Documentation

Teuchos::RCP<Epetra_Operator> EpetraExt::Epetra_Timed_Operator::A
protected

Stores the base operator.

Definition at line 143 of file EpetraExt_TimedEpetraOperator.hpp.

Teuchos::RCP<Teuchos::Time> EpetraExt::Epetra_Timed_Operator::ApplyTimer
protected

Keeps track of the apply time.

Definition at line 146 of file EpetraExt_TimedEpetraOperator.hpp.

Teuchos::RCP<Teuchos::Time> EpetraExt::Epetra_Timed_Operator::ApplyInverseTimer
protected

Keeps track of the apply inverse time.

Definition at line 149 of file EpetraExt_TimedEpetraOperator.hpp.


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