chombo-discharge
Loading...
Searching...
No Matches
CD_Loads.H
Go to the documentation of this file.
1/*
2 * SPDX-FileCopyrightText: 2021-2026 SINTEF Energy Research
3 *
4 * SPDX-License-Identifier: GPL-3.0-or-later
5 */
6
13#ifndef CD_LOADS_H
14#define CD_LOADS_H
15
16// Std includes
17#include <vector>
18#include <map>
19
20// Chombo includes
21#include <Vector.H>
22
23// Our includes
24#include <CD_NamespaceHeader.H>
25
30class Loads
31{
32public:
36 Loads() noexcept;
37
41 virtual ~Loads() noexcept;
42
47 virtual std::map<int, Real>&
48 getLoads() noexcept;
49
54 virtual const std::map<int, Real>&
55 getLoads() const noexcept;
56
60 virtual void
61 resetLoads() noexcept;
62
67 virtual void
69
74 virtual void
76
81 virtual void
83
88 virtual void
90
95 virtual void
97
102 virtual void
104
110 virtual void
111 incrementLoad(const int a_rank, const Real a_increment) noexcept;
112
119 getSortedLoads() const noexcept;
120
121protected:
127};
128
129#include <CD_NamespaceFooter.H>
130
131#endif
Class for holding computational loads.
Definition CD_Loads.H:31
Loads() noexcept
Constructor. Assigns zero loads.
Definition CD_Loads.cpp:24
virtual void assignLoads(const std::map< int, Real > &a_assignedLoads) noexcept
Assign loads.
Definition CD_Loads.cpp:67
virtual ~Loads() noexcept
Destructor (does nothing).
Definition CD_Loads.cpp:31
virtual void resetLoads() noexcept
Reset loads. Sets all loads to 0.
Definition CD_Loads.cpp:55
virtual std::map< int, Real > & getLoads() noexcept
Get the computational loads.
Definition CD_Loads.cpp:39
std::map< int, Real > m_loads
Actual computational loads per MPI rank.
Definition CD_Loads.H:126
virtual void incrementLoad(const int a_rank, const Real a_increment) noexcept
Increment load on rank.
Definition CD_Loads.cpp:169
virtual void incrementLoads(const std::map< int, Real > &a_increments) noexcept
Increment loads. In this version a_increments[0] is the load increment for rank 0,...
Definition CD_Loads.cpp:118
virtual std::vector< std::pair< int, Real > > getSortedLoads() const noexcept
Get sorted loads.
Definition CD_Loads.cpp:184
Base class for a tracer particle solver. This solver can advance particles in a pre-defined velocity ...
Definition CD_TracerParticleSolver.H:38
TracerParticleSolver()
Default constructor.
Definition CD_TracerParticleSolverImplem.H:26