geopm::PowerBalancerAgent(3) -- agent optimizing performance under a power cap
==============================================================================


Synopsis
--------

#include `<geopm/PowerBalancerAgent.hpp> <https://github.com/geopm/geopm/blob/dev/src/PowerBalancerAgent.hpp>`_

Link with ``-lgeopm`` **(MPI)** or ``-lgeopm`` **(non-MPI)**

Description
-----------

The ``PowerBalancerAgent`` is designed to enforce an application wide average
per-compute-node power cap while varying the power cap of individual compute nodes
to optimize overall application performance.

The behavior of this agent is described in more detail in the
:doc:`geopm_agent_power_balancer(7) <geopm_agent_power_balancer.7>` man page.  The balancing algorithm
is implemented using the :doc:`geopm::PowerBalancer(3) <GEOPM_CXX_MAN_PowerBalancer.3>` class.

This class uses the :doc:`geopm::PowerGovernor(3) <GEOPM_CXX_MAN_PowerGovernor.3>` to enforce power limits.

For more details, see the doxygen
page at https://geopm.github.io/doxall/classgeopm_1_1_power_balancer_agent.html.

See Also
--------

:doc:`geopm(7) <geopm.7>`\ ,
:doc:`geopm::Agent(3) <GEOPM_CXX_MAN_Agent.3>`\ ,
:doc:`geopm_agent_power_balancer(7) <geopm_agent_power_balancer.7>`\ ,
:doc:`geopm::PowerBalancer(3) <GEOPM_CXX_MAN_PowerBalancer.3>`\ ,
:doc:`geopm::PowerGovernor(3) <GEOPM_CXX_MAN_PowerGovernor.3>`