vt::vrt::collection::balance::ProposedReassignment struct

Base classes

class ComposedModel
Utility class to support implementation of composable load modeling components.

Constructors, destructors, conversion operators

ProposedReassignment(std::shared_ptr<balance::LoadModel> base, std::shared_ptr<const Reassignment> reassignment)

Public functions

auto begin() const -> ObjectIterator override
auto getNumObjects() const -> int override
auto getModeledLoad(ElementIDStruct object, PhaseOffset when) const -> LoadType override
Provide an estimate of the given object's load during a specified interval.
auto getRawLoad(ElementIDStruct object, PhaseOffset when) const -> LoadType override
Provide the given object's raw load during a specified interval.
auto getUserData(ElementIDStruct object, PhaseOffset when) const -> ElmUserDataType override
Provide the given object's user data during a specified interval.

Function documentation

ObjectIterator vt::vrt::collection::balance::ProposedReassignment::begin() const override

Object enumeration, to abstract away access to the underlying structures from NodeLBData

The updateLoads method must have been called before any call to this.

int vt::vrt::collection::balance::ProposedReassignment::getNumObjects() const override

Object enumeration, to abstract away access to the underlying structures from NodeLBData

The updateLoads method must have been called before any call to this.

LoadType vt::vrt::collection::balance::ProposedReassignment::getModeledLoad(ElementIDStruct object, PhaseOffset when) const override

Provide an estimate of the given object's load during a specified interval.

Parameters
object in The object whose load is desired
when in The interval in which the estimated load is desired
Returns How much computation time the object is estimated to require

The updateLoads method must have been called before any call to this.

LoadType vt::vrt::collection::balance::ProposedReassignment::getRawLoad(ElementIDStruct object, PhaseOffset when) const override

Provide the given object's raw load during a specified interval.

Parameters
object in The object whose raw load is desired
when in The interval in which the raw load is desired
Returns How much computation time the object required

ElmUserDataType vt::vrt::collection::balance::ProposedReassignment::getUserData(ElementIDStruct object, PhaseOffset when) const override

Provide the given object's user data during a specified interval.

Parameters
object in The object whose user data is desired
when in The interval in which the user data is desired
Returns The user data associated with the object