Class grid3D_metrics_collector

Defined in File grid3D_metrics_collector.hpp

Inheritance Relationships

Base Type

public rcppsw::metrics::base_collector (Class base_collector)

Class Documentation

class grid3D_metrics_collector : public rcppsw::metrics::base_collector 

Base class for collectors using a 3D grid to fill with counts of SOMETHING, to be averaged over the entire simulation. Each line of the resulting .csv file corresponds to an XY plane for a value of Z in the grid.

Public Functions

inline grid3D_metrics_collector(std::unique_ptr<rmetrics::base_sink> sink, const math::vector3z &dims)

Parameters:

sink – The metrics sink to use.
dims – Dimensions of grid.

template<typename ...Args> inline auto Func(Args&&... args) -> decltype(std::declval<decltype(Member)>().Func(args...))

template<typename ...Args> inline auto Func(Args&&... args) -> decltype(std::declval<decltype(Member)>().Func(args...))

template<typename ...Args> inline auto Func(Args&&... args) -> decltype(std::declval<decltype(Member)>().Func(args...))

Protected Functions

inline virtual const rmetrics::base_data *data(void) const override: Get a handle to the gathered data.

inline void inc_cell_count(const math::vector3z &c, size_t count = 1)

inline void inc_total_count(size_t count = 1)