aboutsummaryrefslogtreecommitdiff
path: root/Source/Diagnostics/ReducedDiags/LoadBalanceEfficiency.H
blob: d0c823fb9497e3ec0ea8cac57c41c3a3747b564d (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
/* Copyright 2020-2021 Michael Rowan, Yinjian Zhao
 *
 * This file is part of WarpX.
 *
 * License: BSD-3-Clause-LBNL
 */

#ifndef WARPX_DIAGNOSTICS_REDUCEDDIAGS_LOADBALANCEEFFICIENCY_H_
#define WARPX_DIAGNOSTICS_REDUCEDDIAGS_LOADBALANCEEFFICIENCY_H_

#include "ReducedDiags.H"

#include <string>

/**
 *  This class mainly contains a function that gets the
 *  current load balance efficiency for writing to output.
 */
class LoadBalanceEfficiency : public ReducedDiags
{
public:

    /**
     * constructor
     * @param[in] rd_name reduced diags names
     */
    LoadBalanceEfficiency(std::string rd_name);

    /**
     * This function gets the current load balance efficiency
     *
     * @param[in] step current time step
     */
    virtual void ComputeDiags(int step) override final;
};

#endif