Xpetra Version of the Day
Loading...
Searching...
No Matches
Xpetra::EpetraInverseOperator< EpetraGlobalOrdinal, Node > Class Template Reference

#include <Xpetra_EpetraOperator.hpp>

Inheritance diagram for Xpetra::EpetraInverseOperator< EpetraGlobalOrdinal, Node >:
Xpetra::Operator< double, int, EpetraGlobalOrdinal, Node > Teuchos::Describable Teuchos::LabeledObject

Public Member Functions

virtual Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > getDomainMap () const
 The Map associated with the domain of this operator, which must be compatible with X.getMap().
 
virtual Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > getRangeMap () const
 The Map associated with the range of this operator, which must be compatible with Y.getMap().
 
virtual void apply (const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &X, MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &Y, Teuchos::ETransp mode=Teuchos::NO_TRANS, Scalar alpha=Teuchos::ScalarTraits< Scalar >::one(), Scalar beta=Teuchos::ScalarTraits< Scalar >::zero()) const
 Computes the operator-multivector application.
 
virtual bool hasTransposeApply () const
 Whether this operator supports applying the transpose or conjugate transpose.
 
- Public Member Functions inherited from Xpetra::Operator< double, int, EpetraGlobalOrdinal, Node >
virtual ~Operator ()
 
virtual void removeEmptyProcessesInPlace (const RCP< const Map > &)
 
- Public Member Functions inherited from Teuchos::Describable
void describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
 
virtual ~Describable ()
 
DescribableStreamManipulatorState describe (const Describable &describable, const EVerbosityLevel verbLevel=Describable::verbLevel_default)
 
std::ostream & operator<< (std::ostream &os, const DescribableStreamManipulatorState &d)
 
void describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
 
virtual ~Describable ()
 
- Public Member Functions inherited from Teuchos::LabeledObject
 LabeledObject ()
 
virtual ~LabeledObject ()
 
virtual void setObjectLabel (const std::string &objectLabel)
 
virtual std::string getObjectLabel () const
 

Private Types

typedef double Scalar
 
typedef int LocalOrdinal
 
typedef EpetraGlobalOrdinal GlobalOrdinal
 

Xpetra specific

RCP< Epetra_Operatorop_
 The Tpetra::Operator which this class wraps.
 
 EpetraInverseOperator (const Teuchos::RCP< Epetra_Operator > &op)
 EpetraOperator constructor to wrap a Epetra_Operator object.
 
void residual (const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &X, const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &B, MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &R) const
 Compute a residual R = B - (*this) * X.
 

Overridden from Teuchos::Describable

std::string description () const
 A simple one-line description of this object.
 
void describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel=Teuchos::Describable::verbLevel_default) const
 Print the object with the given verbosity level to a FancyOStream.
 

Additional Inherited Members

- Public Types inherited from Xpetra::Operator< double, int, EpetraGlobalOrdinal, Node >
typedef double scalar_type
 The type of the entries of the input and output multivectors.
 
typedef int local_ordinal_type
 The local index type.
 
typedef EpetraGlobalOrdinal global_ordinal_type
 The global index type.
 
typedef Node node_type
 The Kokkos Node type.
 
- Static Public Attributes inherited from Teuchos::Describable
static const EVerbosityLevel verbLevel_default
 

Detailed Description

template<class EpetraGlobalOrdinal, class Node>
class Xpetra::EpetraInverseOperator< EpetraGlobalOrdinal, Node >

Definition at line 178 of file Xpetra_EpetraOperator.hpp.

Member Typedef Documentation

◆ Scalar

template<class EpetraGlobalOrdinal , class Node >
typedef double Xpetra::EpetraInverseOperator< EpetraGlobalOrdinal, Node >::Scalar
private

Definition at line 180 of file Xpetra_EpetraOperator.hpp.

◆ LocalOrdinal

template<class EpetraGlobalOrdinal , class Node >
typedef int Xpetra::EpetraInverseOperator< EpetraGlobalOrdinal, Node >::LocalOrdinal
private

Definition at line 181 of file Xpetra_EpetraOperator.hpp.

◆ GlobalOrdinal

template<class EpetraGlobalOrdinal , class Node >
typedef EpetraGlobalOrdinal Xpetra::EpetraInverseOperator< EpetraGlobalOrdinal, Node >::GlobalOrdinal
private

Definition at line 182 of file Xpetra_EpetraOperator.hpp.

Constructor & Destructor Documentation

◆ EpetraInverseOperator()

template<class EpetraGlobalOrdinal , class Node >
Xpetra::EpetraInverseOperator< EpetraGlobalOrdinal, Node >::EpetraInverseOperator ( const Teuchos::RCP< Epetra_Operator > & op)
inline

EpetraOperator constructor to wrap a Epetra_Operator object.

Definition at line 261 of file Xpetra_EpetraOperator.hpp.

Member Function Documentation

◆ getDomainMap()

template<class EpetraGlobalOrdinal , class Node >
virtual Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::EpetraInverseOperator< EpetraGlobalOrdinal, Node >::getDomainMap ( ) const
inlinevirtual

The Map associated with the domain of this operator, which must be compatible with X.getMap().

Implements Xpetra::Operator< double, int, EpetraGlobalOrdinal, Node >.

Definition at line 188 of file Xpetra_EpetraOperator.hpp.

◆ getRangeMap()

template<class EpetraGlobalOrdinal , class Node >
virtual Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::EpetraInverseOperator< EpetraGlobalOrdinal, Node >::getRangeMap ( ) const
inlinevirtual

The Map associated with the range of this operator, which must be compatible with Y.getMap().

Implements Xpetra::Operator< double, int, EpetraGlobalOrdinal, Node >.

Definition at line 194 of file Xpetra_EpetraOperator.hpp.

◆ apply()

template<class EpetraGlobalOrdinal , class Node >
virtual void Xpetra::EpetraInverseOperator< EpetraGlobalOrdinal, Node >::apply ( const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > & X,
MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > & Y,
Teuchos::ETransp mode = Teuchos::NO_TRANS,
Scalar alpha = Teuchos::ScalarTraits<Scalar>::one(),
Scalar beta = Teuchos::ScalarTraits<Scalar>::zero() ) const
inlinevirtual

Computes the operator-multivector application.

Loosely, performs \(Y = \alpha \cdot A^{\textrm{mode}} \cdot X + \beta \cdot Y\). However, the details of operation vary according to the values of alpha and beta. Specifically

  • if beta == 0, apply() must overwrite Y, so that any values in Y (including NaNs) are ignored.
  • if alpha == 0, apply() may short-circuit the operator, so that any values in X (including NaNs) are ignored.

Implements Xpetra::Operator< double, int, EpetraGlobalOrdinal, Node >.

Definition at line 206 of file Xpetra_EpetraOperator.hpp.

◆ hasTransposeApply()

template<class EpetraGlobalOrdinal , class Node >
virtual bool Xpetra::EpetraInverseOperator< EpetraGlobalOrdinal, Node >::hasTransposeApply ( ) const
inlinevirtual

Whether this operator supports applying the transpose or conjugate transpose.

Reimplemented from Xpetra::Operator< double, int, EpetraGlobalOrdinal, Node >.

Definition at line 234 of file Xpetra_EpetraOperator.hpp.

◆ description()

template<class EpetraGlobalOrdinal , class Node >
std::string Xpetra::EpetraInverseOperator< EpetraGlobalOrdinal, Node >::description ( ) const
inlinevirtual

A simple one-line description of this object.

Reimplemented from Teuchos::Describable.

Definition at line 247 of file Xpetra_EpetraOperator.hpp.

◆ describe()

template<class EpetraGlobalOrdinal , class Node >
void Xpetra::EpetraInverseOperator< EpetraGlobalOrdinal, Node >::describe ( Teuchos::FancyOStream & out,
const Teuchos::EVerbosityLevel verbLevel = Teuchos::Describable::verbLevel_default ) const
inlinevirtual

Print the object with the given verbosity level to a FancyOStream.

Reimplemented from Teuchos::Describable.

Definition at line 250 of file Xpetra_EpetraOperator.hpp.

◆ residual()

template<class EpetraGlobalOrdinal , class Node >
void Xpetra::EpetraInverseOperator< EpetraGlobalOrdinal, Node >::residual ( const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > & X,
const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > & B,
MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > & R ) const
inlinevirtual

Compute a residual R = B - (*this) * X.

Implements Xpetra::Operator< double, int, EpetraGlobalOrdinal, Node >.

Definition at line 265 of file Xpetra_EpetraOperator.hpp.

Member Data Documentation

◆ op_

template<class EpetraGlobalOrdinal , class Node >
RCP< Epetra_Operator> Xpetra::EpetraInverseOperator< EpetraGlobalOrdinal, Node >::op_
private

The Tpetra::Operator which this class wraps.

Definition at line 277 of file Xpetra_EpetraOperator.hpp.


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