particle_monitor.hpp

Go to the documentation of this file.

#pragma once
 
#include <deal.II/base/mpi.h>
 
#include <meltpooldg/particles/obstacle_field.hpp>
#include <meltpooldg/utilities/conditional_ostream.hpp>
#include <meltpooldg/utilities/profiling_data.hpp>
 
#include <cstdint>
#include <string>
 
namespace MeltPoolDG
{
  template <int dim, typename number, typename ObstacleType>
  class ParticleMonitor
  {
  public:
    explicit ParticleMonitor(const ObstacleField<dim, number, ObstacleType> &obstacle_field);
 
    void
    add_info(const Profiling::ProfilingVerbosity verbosity = Profiling::ProfilingVerbosity::none);
 
    void
    print(const ConditionalOStream &pcout, const std::string &title) const;
 
  private:
    struct Statistics
    {
      explicit Statistics(std::string label);
 
      void
      add_info(const unsigned int value);
 
      void
      add_info_with_imbalance(const unsigned int value, MPI_Comm mpi_communicator);
 
      number
      average() const;
 
      number
      average_imbalance() const;
 
      bool
      has_imbalance() const;
 
      Statistics
      get_statistics_across_mpi_ranks(MPI_Comm mpi_communicator) const;
 
      const std::string label;
 
      unsigned int min = 0;
      unsigned int max = 0;
      number sum = 0.;
      uint64_t n_samples = 0;
 
      number imbalance_sum = 0.;
      uint64_t n_imbalance_samples = 0;
    };
 
    struct ParticleStatisticsBasic
    {
      void
      add_info(const ObstacleField<dim, number, ObstacleType> &obstacle_field);
 
      Statistics n_global_particles{"# global particles"};
      Statistics n_locally_owned{"# locally owned particles"};
      Statistics n_ghost{"# ghost particles"};
    };
 
    struct ParticleStatisticsDetailed
    {
      void
      add_info(const ObstacleField<dim, number, ObstacleType> &obstacle_field);
 
      Statistics n_particles_per_cell{"# particle centers per cell"};
    };
 
    ParticleStatisticsBasic    particle_statistics_basic;
    ParticleStatisticsDetailed particle_statistics_detailed;
 
    unsigned int n_calls_basic    = 0;
    unsigned int n_calls_detailed = 0;
 
    const ObstacleField<dim, number, ObstacleType> &obstacle_field;
  };
} // namespace MeltPoolDG