EpetraExt::Epetra_Timed_Operator Class Reference

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

#include <EpetraExt_TimedEpetraOperator.hpp>

List of all members.

Public Member Functions
	Epetra_Timed_Operator (const Teuchos::RCP< Epetra_Operator > &A_)
	Constructor.
virtual	~Epetra_Timed_Operator ()
	Destructor.
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.
virtual double	ApplyTime () const
	Returns the total time applying this operator.
virtual double	ApplyInverseTime () const
	Returns the total time applying the inverse of this operator.
virtual Teuchos::RCP< const Epetra_Operator >	ReturnOperator () const
	Returns a pointer to the underlying Epetra_Operator.
Protected Attributes
Teuchos::RCP< Epetra_Operator >	A
	Stores the base operator.
Teuchos::RCP< Teuchos::Time >	ApplyTimer
	Keeps track of the apply time.
Teuchos::RCP< Teuchos::Time >	ApplyInverseTimer
	Keeps track of the apply inverse time.

---

Detailed Description

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

Definition at line 21 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 9 of file EpetraExt_TimedEpetraOperator.cpp.

EpetraExt::Epetra_Timed_Operator::~Epetra_Timed_Operator

(

)

[virtual]

Destructor.

Definition at line 16 of file EpetraExt_TimedEpetraOperator.cpp.

---

Member Function Documentation

int EpetraExt::Epetra_Timed_Operator::SetUseTranspose

(

bool

useTranspose

)

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

Definition at line 21 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.

Definition at line 29 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.

Definition at line 40 of file EpetraExt_TimedEpetraOperator.cpp.

double EpetraExt::Epetra_Timed_Operator::NormInf

(

)

const [virtual]

Returns an approximate infinity norm of the operator matrix.

Definition at line 51 of file EpetraExt_TimedEpetraOperator.cpp.

const char * EpetraExt::Epetra_Timed_Operator::Label

(

)

const [virtual]

Returns a character string describing the operator.

Definition at line 58 of file EpetraExt_TimedEpetraOperator.cpp.

bool EpetraExt::Epetra_Timed_Operator::UseTranspose

(

)

const [virtual]

Returns the current UseTranspose setting.

Definition at line 64 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.

Definition at line 70 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.

Definition at line 76 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.

Definition at line 81 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.

Definition at line 87 of file EpetraExt_TimedEpetraOperator.cpp.

virtual double EpetraExt::Epetra_Timed_Operator::ApplyTime

(

)

const [inline, virtual]

Returns the total time applying this operator.

Definition at line 84 of file EpetraExt_TimedEpetraOperator.hpp.

virtual double EpetraExt::Epetra_Timed_Operator::ApplyInverseTime

(

)

const [inline, virtual]

Returns the total time applying the inverse of this operator.

Definition at line 89 of file EpetraExt_TimedEpetraOperator.hpp.

virtual Teuchos::RCP<const Epetra_Operator> EpetraExt::Epetra_Timed_Operator::ReturnOperator

(

)

const [inline, virtual]

Returns a pointer to the underlying Epetra_Operator.

Definition at line 94 of file EpetraExt_TimedEpetraOperator.hpp.

---

Member Data Documentation

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

Stores the base operator.

Definition at line 107 of file EpetraExt_TimedEpetraOperator.hpp.

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

Keeps track of the apply time.

Definition at line 110 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 113 of file EpetraExt_TimedEpetraOperator.hpp.

---

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

• EpetraExt_TimedEpetraOperator.hpp
• EpetraExt_TimedEpetraOperator.cpp