ug4
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
ug::HorizontalAlgebraLayouts Class Reference

Holds Interfaces and communicators for horizontal communication. More...

#include <algebra_layouts.h>

+ Inheritance diagram for ug::HorizontalAlgebraLayouts:

Public Member Functions

void clear ()
 clears the struct
 
pcl::InterfaceCommunicator< IndexLayout > & comm () const
 returns (non-const !!!) communicator
 
void enable_overlap (bool enable)
 
 HorizontalAlgebraLayouts ()
 
bool overlap_enabled () const
 Tells whether overlap interfaces should be considered.
 
const pcl::ProcessCommunicator & proc_comm () const
 returns process communicator
 
const IndexLayout & master () const
 
const IndexLayout & master_overlap () const
 
const IndexLayout & slave () const
 
const IndexLayout & slave_overlap () const
 
IndexLayout & master ()
 
IndexLayout & master_overlap ()
 
IndexLayout & slave ()
 
IndexLayout & slave_overlap ()
 
pcl::InterfaceCommunicator< IndexLayout > & comm ()
 
pcl::ProcessCommunicator & proc_comm ()
 

Protected Attributes

pcl::InterfaceCommunicator< IndexLayout > communicator
 communicator
 
bool m_overlapEnabled
 
IndexLayout masterLayout
 (horizontal) master index layout
 
IndexLayout masterOverlapLayout
 
pcl::ProcessCommunicator processCommunicator
 process communicator
 
IndexLayout slaveLayout
 (horizontal) slave index layout
 
IndexLayout slaveOverlapLayout
 

Detailed Description

Holds Interfaces and communicators for horizontal communication.

The internal ProcessCommunicator is initialized as PCD_WORLD.

Constructor & Destructor Documentation

◆ HorizontalAlgebraLayouts()

ug::HorizontalAlgebraLayouts::HorizontalAlgebraLayouts ( )
inline

Member Function Documentation

◆ clear()

void ug::HorizontalAlgebraLayouts::clear ( )
inline

clears the struct

References pcl::SingleLevelLayout< TInterface >::clear(), masterLayout, and slaveLayout.

Referenced by ug::AlgebraLayouts::clear().

◆ comm() [1/2]

pcl::InterfaceCommunicator< IndexLayout > & ug::HorizontalAlgebraLayouts::comm ( )
inline

returns communicator

References communicator.

◆ comm() [2/2]

pcl::InterfaceCommunicator< IndexLayout > & ug::HorizontalAlgebraLayouts::comm ( ) const
inline

returns (non-const !!!) communicator

We return a non-const communicator, since it can only be used non-const. This is requirement of the InterfaceCommunicator design, since internally buffers are used during communication. Theoretically, a communicator could be created each time for communication, but for performance reasons we provide this one that can be shared and reused.

References communicator.

Referenced by ug::BroadcastVectorFromOne(), ug::ConsistencyCheck(), ug::GatherVectorOnOne(), ug::GenerateGlobalConsecutiveIndices(), ug::OverlapWriter< TAlgebra >::init(), ug::AgglomeratingBase< TBase, TAlgebra >::init_mat(), ug::PrintLayouts(), and ug::TestHorizontalAlgebraLayouts().

◆ enable_overlap()

void ug::HorizontalAlgebraLayouts::enable_overlap ( bool  enable)
inline

It is important to enable or disable overlap on all involved processes at the same time. Otherwise communication issues may arise.

References m_overlapEnabled.

◆ master() [1/2]

IndexLayout & ug::HorizontalAlgebraLayouts::master ( )
inline

returns the horizontal slave/master index layout

References masterLayout.

◆ master() [2/2]

const IndexLayout & ug::HorizontalAlgebraLayouts::master ( ) const
inline

returns the horizontal slave/master index layout

References masterLayout.

Referenced by ug::BroadcastVectorFromOne(), ug::CommunicateFromMasterToSlave(), ug::CommunicateFromSlaveToMaster(), ug::ConsistencyCheck(), ug::GatherVectorOnOne(), ug::GenerateGlobalConsecutiveIndices(), ug::AgglomeratingBase< TBase, TAlgebra >::init_mat(), ug::operator<<(), ug::operator<<(), ug::PrintLayouts(), and ug::TestHorizontalAlgebraLayouts().

◆ master_overlap() [1/2]

IndexLayout & ug::HorizontalAlgebraLayouts::master_overlap ( )
inline

returns the horizontal slave/master index layout

References masterOverlapLayout.

◆ master_overlap() [2/2]

const IndexLayout & ug::HorizontalAlgebraLayouts::master_overlap ( ) const
inline

returns the horizontal slave/master index layout

References masterOverlapLayout.

Referenced by ug::OverlapWriter< TAlgebra >::init(), and ug::TestHorizontalAlgebraLayouts().

◆ overlap_enabled()

bool ug::HorizontalAlgebraLayouts::overlap_enabled ( ) const
inline

Tells whether overlap interfaces should be considered.

References m_overlapEnabled.

◆ proc_comm() [1/2]

pcl::ProcessCommunicator & ug::HorizontalAlgebraLayouts::proc_comm ( )
inline

returns communicator

References processCommunicator.

◆ proc_comm() [2/2]

const pcl::ProcessCommunicator & ug::HorizontalAlgebraLayouts::proc_comm ( ) const
inline

returns process communicator

References processCommunicator.

Referenced by ug::CommunicateFromMasterToSlave(), ug::CommunicateFromSlaveToMaster(), ug::ConsistencyCheck(), ug::GenerateGlobalConsecutiveIndices(), ug::AgglomeratingBase< TBase, TAlgebra >::init_mat(), ug::operator<<(), ug::operator<<(), ug::PrintLayouts(), and ug::TestHorizontalAlgebraLayouts().

◆ slave() [1/2]

IndexLayout & ug::HorizontalAlgebraLayouts::slave ( )
inline

returns the horizontal slave/master index layout

References slaveLayout.

◆ slave() [2/2]

const IndexLayout & ug::HorizontalAlgebraLayouts::slave ( ) const
inline

returns the horizontal slave/master index layout

References slaveLayout.

Referenced by ug::BroadcastVectorFromOne(), ug::CommunicateFromMasterToSlave(), ug::CommunicateFromSlaveToMaster(), ug::ConsistencyCheck(), ug::GatherVectorOnOne(), ug::GenerateGlobalConsecutiveIndices(), ug::AgglomeratingBase< TBase, TAlgebra >::init_mat(), ug::operator<<(), ug::operator<<(), ug::PrintLayouts(), and ug::TestHorizontalAlgebraLayouts().

◆ slave_overlap() [1/2]

IndexLayout & ug::HorizontalAlgebraLayouts::slave_overlap ( )
inline

returns the horizontal slave/master index layout

References slaveOverlapLayout.

◆ slave_overlap() [2/2]

const IndexLayout & ug::HorizontalAlgebraLayouts::slave_overlap ( ) const
inline

returns the horizontal slave/master index layout

References slaveOverlapLayout.

Referenced by ug::OverlapWriter< TAlgebra >::init(), and ug::TestHorizontalAlgebraLayouts().

Member Data Documentation

◆ communicator

pcl::InterfaceCommunicator<IndexLayout> ug::HorizontalAlgebraLayouts::communicator
protected

communicator

Referenced by comm(), and comm().

◆ m_overlapEnabled

bool ug::HorizontalAlgebraLayouts::m_overlapEnabled
protected

Referenced by enable_overlap(), and overlap_enabled().

◆ masterLayout

IndexLayout ug::HorizontalAlgebraLayouts::masterLayout
protected

(horizontal) master index layout

Referenced by clear(), master(), and master().

◆ masterOverlapLayout

IndexLayout ug::HorizontalAlgebraLayouts::masterOverlapLayout
protected

Referenced by master_overlap(), and master_overlap().

◆ processCommunicator

pcl::ProcessCommunicator ug::HorizontalAlgebraLayouts::processCommunicator
protected

process communicator

Referenced by proc_comm(), and proc_comm().

◆ slaveLayout

IndexLayout ug::HorizontalAlgebraLayouts::slaveLayout
protected

(horizontal) slave index layout

Referenced by clear(), slave(), and slave().

◆ slaveOverlapLayout

IndexLayout ug::HorizontalAlgebraLayouts::slaveOverlapLayout
protected

Referenced by slave_overlap(), and slave_overlap().

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