Reference documentation for deal.II version GIT acb749f4f5 2024-02-21 16:10:02+00:00
\(\newcommand{\dealvcentcolon}{\mathrel{\mathop{:}}}\) \(\newcommand{\dealcoloneq}{\dealvcentcolon\mathrel{\mkern-1.2mu}=}\) \(\newcommand{\jump}[1]{\left[\!\left[ #1 \right]\!\right]}\) \(\newcommand{\average}[1]{\left\{\!\left\{ #1 \right\}\!\right\}}\)
Loading...
Searching...
No Matches
Public Member Functions | Private Attributes | List of all members
LinearAlgebra::TpetraWrappers::CommunicationPattern Class Reference

#include <deal.II/lac/trilinos_tpetra_communication_pattern.h>

Inheritance diagram for LinearAlgebra::TpetraWrappers::CommunicationPattern:
Inheritance graph
[legend]

Public Member Functions

 CommunicationPattern (const IndexSet &locally_owned_indices, const IndexSet &ghost_indices, const MPI_Comm communicator)
 
virtual void reinit (const IndexSet &locally_owned_indices, const IndexSet &ghost_indices, const MPI_Comm communicator) override
 
virtual MPI_Comm get_mpi_communicator () const override
 
const Tpetra::Import< int, types::signed_global_dof_index > & get_tpetra_import () const
 
Teuchos::RCP< const Tpetra::Import< int, types::signed_global_dof_index > > get_tpetra_import_rcp () const
 
const Tpetra::Export< int, types::signed_global_dof_index > & get_tpetra_export () const
 
Teuchos::RCP< const Tpetra::Export< int, types::signed_global_dof_index > > get_tpetra_export_rcp () const
 

Private Attributes

Teuchos::RCP< const MPI_Commcomm
 
Teuchos::RCP< Tpetra::Import< int, types::signed_global_dof_index > > tpetra_import
 
Teuchos::RCP< Tpetra::Export< int, types::signed_global_dof_index > > tpetra_export
 

Detailed Description

This class implements a wrapper to Tpetra::Import and Tpetra::Export.

Definition at line 40 of file trilinos_tpetra_communication_pattern.h.

Constructor & Destructor Documentation

◆ CommunicationPattern()

LinearAlgebra::TpetraWrappers::CommunicationPattern::CommunicationPattern ( const IndexSet locally_owned_indices,
const IndexSet ghost_indices,
const MPI_Comm  communicator 
)

Initialize the communication pattern.

Parameters
[in]locally_owned_indicesThe set of indices of elements in the array mentioned in the class documentation that are stored on the current process.
[in]ghost_indicesThe set of indices of elements in the array mentioned in the class documentation that the current process will need to be able to import.
[in]communicatorThe MPI communicator used to describe the entire set of processes that participate in the storage and access to elements of the array.

Definition at line 32 of file trilinos_tpetra_communication_pattern.cc.

Member Function Documentation

◆ reinit()

void LinearAlgebra::TpetraWrappers::CommunicationPattern::reinit ( const IndexSet locally_owned_indices,
const IndexSet ghost_indices,
const MPI_Comm  communicator 
)
overridevirtual

Reinitialize the communication pattern.

Parameters
[in]locally_owned_indicesThe set of indices of elements in the array mentioned in the class documentation that are stored on the current process.
[in]ghost_indicesThe set of indices of elements in the array mentioned in the class documentation that the current process will need to be able to import.
[in]communicatorThe MPI communicator used to describe the entire set of processes that participate in the storage and access to elements of the array.

Implements Utilities::MPI::CommunicationPatternBase.

Definition at line 48 of file trilinos_tpetra_communication_pattern.cc.

◆ get_mpi_communicator()

MPI_Comm LinearAlgebra::TpetraWrappers::CommunicationPattern::get_mpi_communicator ( ) const
overridevirtual

Return the underlying MPI communicator.

Implements Utilities::MPI::CommunicationPatternBase.

Definition at line 73 of file trilinos_tpetra_communication_pattern.cc.

◆ get_tpetra_import()

const Tpetra::Import< int, types::signed_global_dof_index > & LinearAlgebra::TpetraWrappers::CommunicationPattern::get_tpetra_import ( ) const

Return the underlying Tpetra::Import object.

Definition at line 81 of file trilinos_tpetra_communication_pattern.cc.

◆ get_tpetra_import_rcp()

Teuchos::RCP< const Tpetra::Import< int, types::signed_global_dof_index > > LinearAlgebra::TpetraWrappers::CommunicationPattern::get_tpetra_import_rcp ( ) const

Return a Teuchos::RCP to the underlying Tpetra::Import object.

Definition at line 89 of file trilinos_tpetra_communication_pattern.cc.

◆ get_tpetra_export()

const Tpetra::Export< int, types::signed_global_dof_index > & LinearAlgebra::TpetraWrappers::CommunicationPattern::get_tpetra_export ( ) const

Return the underlying Tpetra::Export object.

Definition at line 97 of file trilinos_tpetra_communication_pattern.cc.

◆ get_tpetra_export_rcp()

Teuchos::RCP< const Tpetra::Export< int, types::signed_global_dof_index > > LinearAlgebra::TpetraWrappers::CommunicationPattern::get_tpetra_export_rcp ( ) const

Return a Teuchos::RCP to the underlying Tpetra::Export object.

Definition at line 105 of file trilinos_tpetra_communication_pattern.cc.

Member Data Documentation

◆ comm

Teuchos::RCP<const MPI_Comm> LinearAlgebra::TpetraWrappers::CommunicationPattern::comm
private

Teuchos::RCP to the MPI communicator used.

Definition at line 112 of file trilinos_tpetra_communication_pattern.h.

◆ tpetra_import

Teuchos::RCP<Tpetra::Import<int, types::signed_global_dof_index> > LinearAlgebra::TpetraWrappers::CommunicationPattern::tpetra_import
private

Teuchos::RCP to the Tpetra::Import object used.

Definition at line 118 of file trilinos_tpetra_communication_pattern.h.

◆ tpetra_export

Teuchos::RCP<Tpetra::Export<int, types::signed_global_dof_index> > LinearAlgebra::TpetraWrappers::CommunicationPattern::tpetra_export
private

Teuchos::RCP to the Tpetra::Export object used.

Definition at line 124 of file trilinos_tpetra_communication_pattern.h.


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