ParticleStatisticsBasic Struct Reference

Developer Documentation: MeltPoolDG::ParticleMonitor< dim, number, ObstacleType >::ParticleStatisticsBasic Struct Reference
Developer Documentation
MeltPoolDG::ParticleMonitor< dim, number, ObstacleType >::ParticleStatisticsBasic Struct Reference
Collaboration diagram for MeltPoolDG::ParticleMonitor< dim, number, ObstacleType >::ParticleStatisticsBasic:
[legend]

Public Member Functions

void add_info (const ObstacleField< dim, number, ObstacleType > &obstacle_field)
 

Public Attributes

Statistics n_global_particles {"# global particles"}
 
Statistics n_locally_owned {"# locally owned particles"}
 
Statistics n_ghost {"# ghost particles"}
 

Detailed Description

template<int dim, typename number, typename ObstacleType>
struct MeltPoolDG::ParticleMonitor< dim, number, ObstacleType >::ParticleStatisticsBasic

Statistics which are cheap to collect and recorded on every call to add_info().

Member Function Documentation

◆ add_info()

template<int dim, typename number , typename ObstacleType >
void MeltPoolDG::ParticleMonitor< dim, number, ObstacleType >::ParticleStatisticsBasic::add_info ( const ObstacleField< dim, number, ObstacleType > &  obstacle_field)

Records the number of global, locally owned and ghost particles of obstacle_field, including the load imbalance of the latter two.

Parameters
obstacle_fieldThe monitored obstacle field.
Note
This is a collective operation and must be called on all MPI ranks in the MPI communicator of the obstacle field.

Member Data Documentation

◆ n_ghost

template<int dim, typename number , typename ObstacleType >
Statistics MeltPoolDG::ParticleMonitor< dim, number, ObstacleType >::ParticleStatisticsBasic::n_ghost {"# ghost particles"}

◆ n_global_particles

template<int dim, typename number , typename ObstacleType >
Statistics MeltPoolDG::ParticleMonitor< dim, number, ObstacleType >::ParticleStatisticsBasic::n_global_particles {"# global particles"}

◆ n_locally_owned

template<int dim, typename number , typename ObstacleType >
Statistics MeltPoolDG::ParticleMonitor< dim, number, ObstacleType >::ParticleStatisticsBasic::n_locally_owned {"# locally owned particles"}

The documentation for this struct was generated from the following files: