Tpetra parallel linear algebra Version of the Day
Loading...
Searching...
No Matches
Public Member Functions | List of all members
Tpetra::Reindex_MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > Class Template Referenceabstract

#include <Tpetra_Reindex_MultiVector_decl.hpp>

Inherits Tpetra::ViewTransform< T >.

Public Member Functions

 Reindex_MultiVector (Teuchos::RCP< Map< LocalOrdinal, GlobalOrdinal, Node > const > newRowMap)
 
 ~Reindex_MultiVector ()
 
NewType operator() (OriginalType const &origMultiVector)
 
Pure Virtual Methods which must be implemented by subclasses
virtual NewType operator() (const OriginalType &orig)=0
 Analysis of transform operation on original object and construction of new object.
 

Virtual functions with default implements allowing for optional

implementation by the Transform developer

virtual void analyze (const OriginalType &orig)
 Initial analysis phase of transform.
 
virtual NewType construct ()
 Construction of new object as a result of the transform.
 
virtual bool isConstructed ()
 Check if transformed object has been constructed.
 

Detailed Description

template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
class Tpetra::Reindex_MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >

Given an input Tpetra MultiVector, a "reindexed" view is returned.

Definition at line 28 of file Tpetra_Reindex_MultiVector_decl.hpp.

Constructor & Destructor Documentation

◆ Reindex_MultiVector()

Tpetra::Reindex_MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Reindex_MultiVector ( Teuchos::RCP< Map< LocalOrdinal, GlobalOrdinal, Node > const newRowMap)

Constructor

Definition at line 31 of file Tpetra_Reindex_MultiVector_def.hpp.

◆ ~Reindex_MultiVector()

Destructor

Definition at line 42 of file Tpetra_Reindex_MultiVector_def.hpp.

Member Function Documentation

◆ operator()() [1/2]

Reindex_MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::NewType Tpetra::Reindex_MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::operator() ( OriginalType const origMultiVector)

Constructs a "reindexed" view of the original using the given NewRowMap.

Definition at line 51 of file Tpetra_Reindex_MultiVector_def.hpp.

◆ operator()() [2/2]

virtual NewType Tpetra::Transform< T, T >::operator() ( const OriginalType &  orig)
pure virtualinherited

Analysis of transform operation on original object and construction of new object.

Returns
Returns an RCP to the newly created object of type NewType.

◆ analyze()

void Tpetra::Transform< T, T >::analyze ( const OriginalType &  orig)
virtualinherited

Initial analysis phase of transform.

Initial analysis phase of transform to confirm the transform is possible allowing methods construct(), fwd() and rvs() to be successfully utilized.

The default implementation calls method operator() and stores the resulting object in an internal attribute newObj_.

Definition at line 83 of file Tpetra_Transform.hpp.

◆ construct()

Transform< T, T >::NewType Tpetra::Transform< T, T >::construct ( )
virtualinherited

Construction of new object as a result of the transform.

The default implementation returns internal attribute newObj_.

Definition at line 88 of file Tpetra_Transform.hpp.

◆ isConstructed()

bool Tpetra::Transform< T, T >::isConstructed ( )
virtualinherited

Check if transformed object has been constructed.

The default implementation returns true if newObj_ != 0.

Definition at line 94 of file Tpetra_Transform.hpp.


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