vt::vrt::collection::balance::Norm class
#include <src/vt/vrt/collection/balance/model/norm.h>

A load model that computes an l-norm of a given power across subphases.

Base classes

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

Constructors, destructors, conversion operators

Norm(std::shared_ptr<balance::LoadModel> base, double power)
Constructor.

Public functions

auto getModeledLoad(ElementIDStruct object, PhaseOffset when) const -> LoadType override
Provide an estimate of the given object's load during a specified interval.

Function documentation

vt::vrt::collection::balance::Norm::Norm(std::shared_ptr<balance::LoadModel> base, double power)

Constructor.

Parameters
base
power in The power to use in computing the norms. Must be >0. Pass +infinity for a max over subphases

LoadType vt::vrt::collection::balance::Norm::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.