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 More... | |
| pcl::InterfaceCommunicator< IndexLayout > & | comm () const |
| returns (non-const !!!) communicator More... | |
| void | enable_overlap (bool enable) |
| HorizontalAlgebraLayouts () | |
| bool | overlap_enabled () const |
| Tells whether overlap interfaces should be considered. More... | |
| const pcl::ProcessCommunicator & | proc_comm () const |
| returns process communicator More... | |
| 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 More... | |
| bool | m_overlapEnabled |
| IndexLayout | masterLayout |
| (horizontal) master index layout More... | |
| IndexLayout | masterOverlapLayout |
| pcl::ProcessCommunicator | processCommunicator |
| process communicator More... | |
| IndexLayout | slaveLayout |
| (horizontal) slave index layout More... | |
| IndexLayout | slaveOverlapLayout |
Detailed Description
Holds Interfaces and communicators for horizontal communication.
The internal ProcessCommunicator is initialized as PCD_WORLD.
Constructor & Destructor Documentation
◆ HorizontalAlgebraLayouts()
|
inline |
Member Function Documentation
◆ clear()
|
inline |
clears the struct
References pcl::SingleLevelLayout< TInterface >::clear(), masterLayout, and slaveLayout.
Referenced by ug::AlgebraLayouts::clear().
◆ comm() [1/2]
|
inline |
returns communicator
References communicator.
◆ comm() [2/2]
|
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()
|
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]
|
inline |
returns the horizontal slave/master index layout
References masterLayout.
◆ master() [2/2]
|
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::PrintLayouts(), and ug::TestHorizontalAlgebraLayouts().
◆ master_overlap() [1/2]
|
inline |
returns the horizontal slave/master index layout
References masterOverlapLayout.
◆ master_overlap() [2/2]
|
inline |
returns the horizontal slave/master index layout
References masterOverlapLayout.
Referenced by ug::OverlapWriter< TAlgebra >::init(), and ug::TestHorizontalAlgebraLayouts().
◆ overlap_enabled()
|
inline |
Tells whether overlap interfaces should be considered.
References m_overlapEnabled.
◆ proc_comm() [1/2]
|
inline |
returns communicator
References processCommunicator.
◆ proc_comm() [2/2]
|
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::PrintLayouts(), and ug::TestHorizontalAlgebraLayouts().
◆ slave() [1/2]
|
inline |
returns the horizontal slave/master index layout
References slaveLayout.
◆ slave() [2/2]
|
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::PrintLayouts(), and ug::TestHorizontalAlgebraLayouts().
◆ slave_overlap() [1/2]
|
inline |
returns the horizontal slave/master index layout
References slaveOverlapLayout.
◆ slave_overlap() [2/2]
|
inline |
returns the horizontal slave/master index layout
References slaveOverlapLayout.
Referenced by ug::OverlapWriter< TAlgebra >::init(), and ug::TestHorizontalAlgebraLayouts().
Member Data Documentation
◆ communicator
|
protected |
communicator
Referenced by comm().
◆ m_overlapEnabled
|
protected |
Referenced by enable_overlap(), and overlap_enabled().
◆ masterLayout
|
protected |
◆ masterOverlapLayout
|
protected |
Referenced by master_overlap().
◆ processCommunicator
|
protected |
process communicator
Referenced by proc_comm().
◆ slaveLayout
|
protected |
◆ slaveOverlapLayout
|
protected |
Referenced by slave_overlap().
The documentation for this class was generated from the following file:
- ugbase/lib_algebra/parallelization/algebra_layouts.h
