dune-pdelab  2.7-git
Public Member Functions | List of all members
Dune::PDELab::ISTL::ParallelHelper< GFS > Class Template Reference

#include <dune/pdelab/backend/istl/parallelhelper.hh>

Inheritance diagram for Dune::PDELab::ISTL::ParallelHelper< GFS >:
Inheritance graph

Public Member Functions

 ParallelHelper (const GFS &gfs, int verbose=1)
 
const std::vector< RankIndex > & getNeighborRanks () const
 Returns a sorted list of the ranks of all neighboring processes. More...
 
template<typename X >
void maskForeignDOFs (X &x) const
 Mask out all DOFs not owned by the current process with 0. More...
 
bool owned (const ContainerIndex &i) const
 Tests whether the given index is owned by this process. More...
 
bool isGhost (const ContainerIndex &i) const
 Tests whether the given index belongs to a ghost DOF. More...
 
template<typename X , typename Y >
PromotionTraits< typename X::field_type, typename Y::field_type >::PromotedType disjointDot (const X &x, const Y &y) const
 Calculates the (rank-local) dot product of x and y on the disjoint partition defined by the helper. More...
 
RankIndex rank () const
 Returns the MPI rank of this process. More...
 

Constructor & Destructor Documentation

◆ ParallelHelper()

template<typename GFS >
Dune::PDELab::ISTL::ParallelHelper< GFS >::ParallelHelper ( const GFS &  gfs,
int  verbose = 1 
)
inline

Member Function Documentation

◆ disjointDot()

template<typename GFS >
template<typename X , typename Y >
PromotionTraits< typename X::field_type, typename Y::field_type >::PromotedType Dune::PDELab::ISTL::ParallelHelper< GFS >::disjointDot ( const X &  x,
const Y &  y 
) const
inline

Calculates the (rank-local) dot product of x and y on the disjoint partition defined by the helper.

◆ getNeighborRanks()

template<typename GFS >
const std::vector<RankIndex>& Dune::PDELab::ISTL::ParallelHelper< GFS >::getNeighborRanks ( ) const
inline

Returns a sorted list of the ranks of all neighboring processes.

◆ isGhost()

template<typename GFS >
bool Dune::PDELab::ISTL::ParallelHelper< GFS >::isGhost ( const ContainerIndex &  i) const
inline

Tests whether the given index belongs to a ghost DOF.

◆ maskForeignDOFs()

template<typename GFS >
template<typename X >
void Dune::PDELab::ISTL::ParallelHelper< GFS >::maskForeignDOFs ( X &  x) const
inline

Mask out all DOFs not owned by the current process with 0.

◆ owned()

template<typename GFS >
bool Dune::PDELab::ISTL::ParallelHelper< GFS >::owned ( const ContainerIndex &  i) const
inline

Tests whether the given index is owned by this process.

◆ rank()

template<typename GFS >
RankIndex Dune::PDELab::ISTL::ParallelHelper< GFS >::rank ( ) const
inline

Returns the MPI rank of this process.


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