vt::ctx::LBData struct

Context for collection of LB data when a task runs.

Public types

using ElementIDStruct = elm::ElementIDStruct
using ElementLBData = elm::ElementLBData

Constructors, destructors, conversion operators

LBData() defaulted
template<typename ElmT, typename MsgT>
LBData(ElmT* in_elm, MsgT* msg)
Construct a LBData.
LBData(ElementLBData* in_lb_data, ElementIDStruct const& in_elm_id)
Construct a LBData.

Public functions

auto needsTime() const -> bool
Return whether time is required.
void start(TimeType time)
Set the context and timing for a collection task.
void finish(TimeType time)
Remove the context and store timing for a collection task.
void send(elm::ElementIDStruct dest, MsgSizeType bytes)
Record LB data whenever a message is sent and a collection element is running.
void suspend(TimeType time)
void resume(TimeType time)
auto getCurrentElementID() const -> ElementIDStruct const &
Get the current element ID struct for the running context.

Function documentation

template<typename ElmT, typename MsgT>
vt::ctx::LBData::LBData(ElmT* in_elm, MsgT* msg)

Construct a LBData.

Parameters
in_elm in the collection element
msg in the incoming message (used for communication LB data)

vt::ctx::LBData::LBData(ElementLBData* in_lb_data, ElementIDStruct const& in_elm_id)

Construct a LBData.

Parameters
in_lb_data in the LB data
in_elm_id in the element ID

void vt::ctx::LBData::send(elm::ElementIDStruct dest, MsgSizeType bytes)

Record LB data whenever a message is sent and a collection element is running.

Parameters
dest in the destination of the message
bytes

ElementIDStruct const & vt::ctx::LBData::getCurrentElementID() const

Get the current element ID struct for the running context.

Returns the current element ID