Shamrock 2025.10.0
Astrophysical Code
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Public Attributes | List of all members
sham::DDMultiRef< Targ > Struct Template Reference

A variant of sham::MultiRef for distributed data. More...

#include <shambackends/include/shambackends/kernel_call_distrib.hpp>

Public Types

using storage_t = std::tuple< Targ &... >
 A tuple of references to the buffers.
 

Public Member Functions

 DDMultiRef (Targ &...arg)
 Constructor.
 
auto get (u64 id)
 Get a MultiRef at a given id.
 

Public Attributes

storage_t storage
 A tuple of references to the buffers.
 

Detailed Description

template<class... Targ>
struct sham::DDMultiRef< Targ >

A variant of sham::MultiRef for distributed data.

This class is a drop-in replacement for sham::MultiRef but adapted to work with distributed data.

See also
sham::MultiRef

Definition at line 33 of file kernel_call_distrib.hpp.

Member Typedef Documentation

◆ storage_t

template<class... Targ>
using sham::DDMultiRef< Targ >::storage_t = std::tuple<Targ &...>

A tuple of references to the buffers.

Definition at line 35 of file kernel_call_distrib.hpp.

Constructor & Destructor Documentation

◆ DDMultiRef()

template<class... Targ>
sham::DDMultiRef< Targ >::DDMultiRef ( Targ &...  arg)
inline

Constructor.

Definition at line 41 of file kernel_call_distrib.hpp.

Member Function Documentation

◆ get()

template<class... Targ>
auto sham::DDMultiRef< Targ >::get ( u64  id)
inline

Get a MultiRef at a given id.

This function returns a MultiRef of the buffers at the given id.

Parameters
idThe id of the patch for which to get the MultiRef.
Returns
A MultiRef of the buffers at the given id.

Definition at line 51 of file kernel_call_distrib.hpp.

+ Here is the call graph for this function:

Member Data Documentation

◆ storage

template<class... Targ>
storage_t sham::DDMultiRef< Targ >::storage

A tuple of references to the buffers.

Definition at line 38 of file kernel_call_distrib.hpp.


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