Tool providing a separate (single) HIP stream to the component using it. More...

#include <PerComponentStreamTool.h>

Inheritance diagram for AthHIP::PerComponentStreamTool:

Collaboration diagram for AthHIP::PerComponentStreamTool:

Public Member Functions
Function(s) inherited from @c AthAlgTool
virtual StatusCode	initialize () override
	Initialize the tool.
Function(s) inherited from @c IStreamTool
virtual hipStream_t	stream (const EventContext &ctx) const override
	Get the HIP stream to use.

Private Attributes
std::unique_ptr< const Details::Stream >	m_stream
	Single HIP stream.

Detailed Description

Tool providing a separate (single) HIP stream to the component using it.

This means that in algorithms using this tool, operations from different events would end up being executed in a single stream. But operations from different components/algorithms could be executed in parallel.

Definition at line 27 of file AthHIP/AthHIPComps/src/PerComponentStreamTool.h.

Member Function Documentation

◆ initialize()

StatusCode AthHIP::PerComponentStreamTool::initialize ( )

overridevirtual

Initialize the tool.

Definition at line 14 of file AthHIP/AthHIPComps/src/PerComponentStreamTool.cxx.

                                              {
 
  // Create the stream object.
  m_stream = std::make_unique<const Details::Stream>();
 
  // Tell the user what happened.
  ATH_MSG_DEBUG("Initialized HIP stream on device: " << m_stream->name());
 
  // Return gracefully.
  return StatusCode::SUCCESS;
}

◆ stream()

hipStream_t AthHIP::PerComponentStreamTool::stream ( const EventContext & ctx ) const

overridevirtual

Get the HIP stream to use.

Parameters

ctx	The event context for which the stream is requested

Returns: The HIP stream to use for the current event context

Definition at line 26 of file AthHIP/AthHIPComps/src/PerComponentStreamTool.cxx.

                                                                    {
 
  // Get the stream corresponding to the current slot.
  assert(m_stream);
  assert(m_stream->stream());
  return m_stream->stream();
}

Member Data Documentation

◆ m_stream

std::unique_ptr<const Details::Stream> AthHIP::PerComponentStreamTool::m_stream

private

Single HIP stream.

Definition at line 55 of file AthHIP/AthHIPComps/src/PerComponentStreamTool.h.

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