dash::halo::HaloUpdateEnv< HaloBlockT, SigReady > Class Template Reference

Public Types
using	HaloMemory_t = HaloMemory< HaloBlockT >
using	Element_t = typename HaloBlockT::Element_t
using	Team_t = dash::Team

Public Member Functions
	HaloUpdateEnv (const HaloBlockT &halo_block, Element_t *local_memory, Team_t &team, const TeamSpec_t &tspec)
void	update ()
	Initiates a blocking halo region update for all halo elements. More...
void	update_at (region_index_t index)
	Initiates a blocking halo region update for all halo elements within the the given region. More...
void	update_async ()
	Initiates an asychronous halo region update for all halo elements. More...
void	update_async_at (region_index_t index)
	Initiates an asychronous halo region update for all halo elements within the given region. More...
void	wait ()
	Waits until all halo updates are finished. More...
void	wait (region_index_t index)
	Waits until the halo updates for the given halo region is finished. More...
void	prepare_update ()
HaloMemory_t &	halo_memory ()
	Returns the halo memory management object HaloMemory. More...
const HaloMemory_t &	halo_memory () const
	Returns the halo memory management object HaloMemory. More...
BlockEnv_t	block_env ()
	Returns the halo environment information object BlockEnvironment. More...
const BlockEnv_t &	block_env () const
	Returns the halo environment information object BlockEnvironment. More...

Detailed Description

template<typename HaloBlockT, SignalReady SigReady>
class dash::halo::HaloUpdateEnv< HaloBlockT, SigReady >

Definition at line 540 of file HaloMemory.h.

Member Function Documentation

block_env() [1/2]

template<typename HaloBlockT, SignalReady SigReady>

BlockEnv_t dash::halo::HaloUpdateEnv< HaloBlockT, SigReady >::block_env ( )

inline

Returns the halo environment information object BlockEnvironment.

Definition at line 682 of file HaloMemory.h.

{ return _halo_block.block_env(); }

block_env() [2/2]

template<typename HaloBlockT, SignalReady SigReady>

const BlockEnv_t& dash::halo::HaloUpdateEnv< HaloBlockT, SigReady >::block_env ( ) const

inline

Returns the halo environment information object BlockEnvironment.

Definition at line 687 of file HaloMemory.h.

{ return _halo_block.block_env() ; }

halo_memory() [1/2]

template<typename HaloBlockT, SignalReady SigReady>

HaloMemory_t& dash::halo::HaloUpdateEnv< HaloBlockT, SigReady >::halo_memory ( )

inline

Returns the halo memory management object HaloMemory.

Definition at line 672 of file HaloMemory.h.

Referenced by dash::halo::HaloMatrixWrapper< MatrixT, SigReady >::set_custom_halos(), and dash::halo::HaloMatrixWrapper< MatrixT, SigReady >::stencil_operator().

{ return _halo_memory; }

halo_memory() [2/2]

template<typename HaloBlockT, SignalReady SigReady>

const HaloMemory_t& dash::halo::HaloUpdateEnv< HaloBlockT, SigReady >::halo_memory ( ) const

inline

Returns the halo memory management object HaloMemory.

Definition at line 677 of file HaloMemory.h.

{ return _halo_memory; }

update()

template<typename HaloBlockT, SignalReady SigReady>

void dash::halo::HaloUpdateEnv< HaloBlockT, SigReady >::update ( )

inline

Initiates a blocking halo region update for all halo elements.

Definition at line 577 of file HaloMemory.h.

Referenced by dash::halo::HaloMatrixWrapper< MatrixT, SigReady >::update().

                {
    prepare_update();
    for(auto& data : _region_data) {
      update_halo_intern(data.first, data.second);
    }
    wait();
  }

update_async()

template<typename HaloBlockT, SignalReady SigReady>

void dash::halo::HaloUpdateEnv< HaloBlockT, SigReady >::update_async ( )

inline

Initiates an asychronous halo region update for all halo elements.

Definition at line 605 of file HaloMemory.h.

Referenced by dash::halo::HaloMatrixWrapper< MatrixT, SigReady >::update_async().

                      {
    prepare_update();
    for(auto& data : _region_data) {
      update_halo_intern(data.first, data.second);
    }
  }

update_async_at()

template<typename HaloBlockT, SignalReady SigReady>

void dash::halo::HaloUpdateEnv< HaloBlockT, SigReady >::update_async_at ( region_index_t  index )

inline

Initiates an asychronous halo region update for all halo elements within the given region.

TODO: find a solution for prepare update

Definition at line 618 of file HaloMemory.h.

Referenced by dash::halo::HaloMatrixWrapper< MatrixT, SigReady >::update_async_at().

                                             {
    auto it_find = _region_data.find(index);
    if(it_find != _region_data.end()) {
      update_halo_intern(it_find->first, it_find->second);
    }
  }

update_at()

template<typename HaloBlockT, SignalReady SigReady>

void dash::halo::HaloUpdateEnv< HaloBlockT, SigReady >::update_at ( region_index_t  index )

inline

Initiates a blocking halo region update for all halo elements within the the given region.

TODO: find a solution for prepare update

Definition at line 591 of file HaloMemory.h.

Referenced by dash::halo::HaloMatrixWrapper< MatrixT, SigReady >::update_at().

                                       {
    auto it_find = _region_data.find(index);
    if(it_find != _region_data.end()) {
      update_halo_intern(it_find->first, it_find->second);
      dart_wait_local(&it_find->second.handle);
      if(SigReady == SignalReady::ON) {
        _signal_env.put_ready_signal_blocking(it_find->first);
      }
    }
  }

wait() [1/2]

template<typename HaloBlockT, SignalReady SigReady>

void dash::halo::HaloUpdateEnv< HaloBlockT, SigReady >::wait ( )

inline

Waits until all halo updates are finished.

Only useful for asynchronous halo updates.

Definition at line 629 of file HaloMemory.h.

Referenced by dash::halo::HaloMatrixWrapper< MatrixT, SigReady >::wait().

              {
    for(auto& region : _region_data) {
      dart_wait_local(&region.second.handle);
      if(SigReady == SignalReady::ON) {
        _signal_env.put_ready_signal_async(region.first);
      }
    }
    if(SigReady == SignalReady::ON) {
      _signal_env.wait_put_ready_signals();
    }
  }

wait() [2/2]

template<typename HaloBlockT, SignalReady SigReady>

void dash::halo::HaloUpdateEnv< HaloBlockT, SigReady >::wait ( region_index_t  index )

inline

Waits until the halo updates for the given halo region is finished.

Only useful for asynchronous halo updates.

Definition at line 645 of file HaloMemory.h.

                                  {
    auto it_find = _region_data.find(index);
    if(it_find == _region_data.end()) {
      return;
    }

    dart_wait_local(&it_find->second.handle);
    if(SigReady == SignalReady::ON) {
      _signal_env.put_ready_signal_blocking(it_find->first);
    }
  }

---

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

• /tmp/tmporruphar/dash/include/dash/halo/HaloMemory.h